ContextQMD
Back to Devexpress

TdxRichEditCustomDocumentServer Members

vcl-dxrichedit-dot-documentserver-dot-tdxricheditcustomdocumentserver-dot-underscore-members.md

latest21.6 KB
Original Source

TdxRichEditCustomDocumentServer Members

The base class for the document server component.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.

Properties

NameDescription
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
DesignInfoInherited from TComponent.
DocBytesSpecifies document content as a byte array (in the Microsoft Word® 97 – 2003 binary format).
Document
HtmlTextSpecifies document content as a string (in the HTML format).
IsUpdateLockedIdentifies if changes to the document server are postponed.
NameInherited from TComponent.
ObserversInherited from TComponent.
OpenXmlBytesSpecifies document content as a byte array (in the Office OpenXML format).
OptionsProvides access to document server settings.
OwnerInherited from TComponent.
RtfTextSpecifies document content (as an RTF string).
TagInherited from TComponent.
TextSpecifies document content (as a plain text string).
VCLComObjectInherited from TComponent.

Methods

NameDescription
AddService(TdxServiceType,IdxServiceCreatorCallback,Boolean)Registers the specified service in the document server component.
AddService(TdxServiceType,IdxServiceCreatorCallback)
AddService(TdxServiceType,IInterface,Boolean)
AddService(TdxServiceType,IInterface)
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject)Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject)Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject)Inherited from TComponent.
BeginInvoke(TProc,TObject)Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject)Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject)Inherited from TComponent.
BeginUpdatePostpones all changes made to the document server or its opened document until an EndUpdate procedure call.
CancelUpdateDiscards all pending changes made to the document server or its document after a BeginUpdate procedure call.
CreateMailMergeOptionsCreates a container for settings usable in mail merge operations.
CreateNewDocument(Boolean)Closes the opened document and creates a new blank document.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndUpdateApplies all pending changes made to the document server or its document after a BeginUpdate procedure call.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
FindComponent(String)Inherited from TComponent.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetHashCodeInherited from TObject.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GetService(TdxServiceType)
GetService<T>
HasParentInherited from TComponent.
InsertComponent(TComponent)Inherited from TComponent.
IsImplementorOf(IInterface)Inherited from TComponent.
LoadDocument(TStream,TdxRichEditDocumentFormat)Imports a document from a stream (in any supported format).
LoadDocument(TStream)Imports a document from a stream (in any supported format).
LoadDocument(string,TdxRichEditDocumentFormat)Imports a document from a file (in any supported format).
LoadDocument(string)Imports a document from a file (in any supported format).
LoadDocumentTemplate(TStream,TdxRichEditDocumentFormat)Imports a document (as a template) from a stream (in any supported format).
LoadDocumentTemplate(string,TdxRichEditDocumentFormat)Imports a document (as a template) from a file (in any supported format).
LoadDocumentTemplate(string)Imports a document (as a template) from a file (in any supported format).
LoadedInherited from TComponent.
MailMerge(IdxRichEditDocument)
MailMerge(IdxRichEditMailMergeOptions,IdxRichEditDocument)
MailMerge(IdxRichEditMailMergeOptions,TStream,TdxRichEditDocumentFormat)
MailMerge(IdxRichEditMailMergeOptions,string,TdxRichEditDocumentFormat)
MailMerge(TStream,TdxRichEditDocumentFormat)
MailMerge(string,TdxRichEditDocumentFormat)
Notification(TComponent,TOperation)Inherited from TComponent.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RemoveService(TdxServiceType,Boolean)
RemoveService(TdxServiceType)
SaveDocumentExports document content to a file using the current export settings.
SaveDocument(TStream,TdxRichEditDocumentFormat)Exports document content to a stream (in any supported format).
SaveDocument(string,TdxRichEditDocumentFormat)Exports document content to a file (in any supported format).
SaveDocument(string)Exports document content to a file (in any supported format).
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ToStringInherited from TObject.
UpdateAction(TBasicAction)Inherited from TComponent.

Events

NameDescription
OnCalculateDocumentVariableEnables you to insert custom content into a DOCVARIABLE field.
OnContentChangedEnables you to respond to content changes in the opened document.
OnCustomizeMergeFields
OnDocumentClosingEnables you to respond to an attempt to close a document with unsaved changes.
OnDocumentLoadedEnables you to respond to a successful document load operation.
OnGetEncryptionPassword
OnMailMergeFinished
OnMailMergeGetTargetDocument
OnMailMergeRecordFinished
OnMailMergeRecordStarted
OnMailMergeStarted

See Also

TdxRichEditCustomDocumentServer Class

dxRichEdit.DocumentServer Unit