Back to Devexpress

TdxPDFDocument Members

vcl-dxpdfdocument-dot-tdxpdfdocument-dot-underscore-members.md

latest6.1 KB
Original Source

TdxPDFDocument Members

A PDF document container.

Properties

NameDescription
AllowContentExtractionIdentifies if users can select and copy the loaded PDF document’s content.
AllowPrintingIdentifies if it is possible to print the loaded PDF document.
FileAttachmentsProvides access to the collection of files attached to the document.
FormProvides access to the document’s form with interactive fields.
InformationProvides access to PDF document metadata.
ModifiedIdentifies if the document has unsaved changes.
PageCountReturns the number of pages in the PDF document.
PageInfoProvides indexed access to document pages.
PagesProvides access to the document structure.
PasswordAttemptsLimitSpecifies the number of allowed attempts to enter the document’s protection password.
SecurityOptionsProvides access to the document’s security settings.
SignatureOptionsProvides access to the document’s digital signature settings.

Methods

NameDescription
Append(TdxPDFDocument)Appends a specified PDF document’s content to the current document.
Append(TStream)Appends a specified PDF document’s content to the current document.
Append(string)Appends a specified PDF document’s content to the current document.
BeginUpdateDisables all document change notifications until an EndUpdate procedure call.
ClearClears the PDF document container.
EndUpdateRe-enables notifications and applies all changes made to the PDF document container and the stored document’s structure after a BeginUpdate call.
Equals(TObject)Inherited from TObject.
FindText(string,TdxPDFDocumentTextSearchOptions,TdxPDFPageTextRanges)Searches all occurrences of the specified text string in the document.
FindText(string,TdxPDFDocumentTextSearchOptions,Integer)Searches for a text string on the specified page of the document.
FindText(string,TdxPDFDocumentTextSearchOptions)Searches for a text string with the specified search settings.
FindText(string)Searches the specified text string in the document with the default search settings.
GetHashCodeInherited from TObject.
LoadFromFile(string)Loads a PDF document from the specified file.
LoadFromStream(TStream)Loads a PDF document from the specified stream.
SaveToFile(string,Boolean,Boolean)Saves the document to a file.
SaveToStream(TStream,Boolean,Boolean)Saves the document to a stream.
ToStringInherited from TObject.

Events

NameDescription
OnChangedOccurs every time the document changes.
OnGetPasswordEnables you to respond to the password request when the PDF document container loads an encrypted document.
OnLoadedEnables you to respond to a successful document load operation.
OnSaveProgressEnables you to track the document save progress.
OnSearchProgressEnables you to track the progress of a time-consuming text search operation in the PDF document.
OnUnloadedEnables you to respond to closing the PDF document.

See Also

TdxPDFDocument Class

dxPDFDocument Unit