SaveToFile(String,PdfEncryption,String,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean) Method
Encrypts the currently loaded PDF document according to a specified encryption algorithm and saves it to a file according to a file path you have specified. Encryption process is not allowed for PDF/A compliant documents.
Please note that encrypted PDF files are always saved without using the packing mechanism. You can however use the standard compression process.
Please read more about the password and permissions security in the GdPicturePDF.SetPassword method.
public GdPictureStatus SaveToFile(
string ,
PdfEncryption ,
string ,
string ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool
)
public function SaveToFile(
: String;
: PdfEncryption;
: String;
: String;
: Boolean;
: Boolean;
: Boolean;
: Boolean;
: Boolean;
: Boolean;
: Boolean;
: Boolean
): GdPictureStatus;
public function SaveToFile(
: String,
: PdfEncryption,
: String,
: String,
: boolean,
: boolean,
: boolean,
: boolean,
: boolean,
: boolean,
: boolean,
: boolean
) : GdPictureStatus;
public: GdPictureStatus SaveToFile(
string* ,
PdfEncryption ,
string* ,
string* ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool
)
public:
GdPictureStatus SaveToFile(
String^ ,
PdfEncryption ,
String^ ,
String^ ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool
)
'Declaration
Public Overloads Function SaveToFile( _
ByVal As String, _
ByVal As PdfEncryption, _
ByVal As String, _
ByVal As String, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean _
) As GdPictureStatus
Parameters
- FilePath
- The file path where the currently loaded PDF document will be saved. If the specified file already exists, it will be overwritten.
You are allowed to overwrite the currently opened PDF document only if the document has been loaded into memory setting the LoadInMemory parameter to true in the previously called GdPicturePDF.LoadFromFile method.
- EncryptionScheme
- A member of the PdfEncryption enumeration. The encryption algorithm you have to specify. This algorithm will be used to encrypt the PDF document according to other specified parameters.
- UserPass
- The user (open) password as a string. You can set null value here or an empty string as well. The null value will alway be converted to an empty string.
Please read more about passwords in the Remarks section.
- OwnerPass
- The owner (permission, master) password as a string. You can set null value here or an empty string as well. The null value will always be converted
to an empty string. Please read more about passwords in the Remarks section.
- CanPrint
- Allows the user to print the document, but possibly not at the highest quality level, see also PdfRightCanPrintFull. It is ignored if the EncryptionScheme
parameter is set to PdfEncryption.PdfEncryptionNone.
- CanCopy
- Allows the user to copy or extract text and graphics from the document. It is ignored if the EncryptionScheme parameter is set to PdfEncryption.PdfEncryptionNone.
- CanModify
- Allows the user to modify the document. It is ignored if the EncryptionScheme parameter is set to PdfEncryption.PdfEncryptionNone.
- CanAddNotes
- Allows the user to add annotations. It is ignored if the EncryptionScheme parameter is set to PdfEncryption.PdfEncryptionNone.
- CanFillFields
- Allows the user to fill-in form fields. It works only with 128-bit encryption.
- CanCopyAccess
- Enables copying or extracting for use with accessibility features. It works only with 128-bit encryption.
- CanAssemble
- Allows the user to assemble the document. It works only with 128-bit encryption.
- CanPrintFull
- Allows high resolution printing of the document. It works only with 128-bit encryption.
Return Value
A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.
We strongly recommend always checking this status first.
How to encrypt and save the PDF document.
Dim caption As String = "Example: SaveToFile"
Dim gdpicturePDF As New GdPicturePDF()
If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then
If gdpicturePDF.SaveToFile("encrypted.pdf", PdfEncryption.PdfEncryption40BitRC4, "user", "owner", False, False, False, False, False, False, False, False) = GdPictureStatus.OK Then
MessageBox.Show("The encrypted file has been saved successfully.", caption)
'Closing the current document.
gdpicturePDF.CloseDocument()
'Loading the encrypted file.
If gdpicturePDF.LoadFromFile("encrypted.pdf", False) = GdPictureStatus.OK Then
'Checking if the file is encrypted.
Dim encrypted As Boolean = gdpicturePDF.IsEncrypted()
MessageBox.Show("The encrypted file has been loaded successfully." + vbCrLf + " The IsEncrypted method returns: " + encrypted.ToString() + " status: " + gdpicturePDF.GetStat().ToString(), caption)
Else
MessageBox.Show("The encrypted file has failed to load.", caption)
End If
Else
MessageBox.Show("The encrypted file has failed to save.", caption)
End If
Else
MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: SaveToFile";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)
{
if (gdpicturePDF.SaveToFile("encrypted.pdf", PdfEncryption.PdfEncryption40BitRC4, "user", "owner", false, false, false, false, false, false, false, false) == GdPictureStatus.OK)
{
MessageBox.Show("The encrypted file has been saved successfully.", caption);
//Closing the current document.
gdpicturePDF.CloseDocument();
//Loading the encrypted file.
if (gdpicturePDF.LoadFromFile("encrypted.pdf", false) == GdPictureStatus.OK)
{
//Checking if the file is encrypted.
bool encrypted = gdpicturePDF.IsEncrypted();
MessageBox.Show("The encrypted file has been loaded successfully.\n The IsEncrypted method returns: " + encrypted.ToString() + " status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
{
MessageBox.Show("The encrypted file has failed to load.", caption);
}
}
else
{
MessageBox.Show("The encrypted file has failed to save.", caption);
}
}
else
{
MessageBox.Show("The file can't be loaded.", caption);
}
gdpicturePDF.Dispose();