Back to Devexpress

RichEditDocumentServer Members

officefileapi-devexpress-dot-xtrarichedit-dot-richeditdocumentserver-dot-underscore-members.md

latest28.9 KB
Original Source

RichEditDocumentServer Members

A non-visual .NET library providing all the word processing functionality.

Constructors

NameDescription
RichEditDocumentServer()Initializes a new instance of the RichEditDocumentServer class with the default settings.

Properties

NameDescription
DocBytesGets or sets the document content as an array of bytes in Microsoft Word 97-2003 format (Doc) format.
DocmBytesGets or sets the document content as an array of bytes in DOCM (Microsoft Office Open XML Macro-Enabled Document) format.
DocumentProvides access to a Document interface, representing the document contained in the server.
DocumentLayoutProvides access to the document layout.
DocxBytesGets or sets the document content as an array of bytes in Office Open XML (Docx) format.
DotBytesGets or sets the document content as an array of bytes in DOT (Microsoft Word 97-2007 Template) format.
DotmBytesGets or sets the document content as an array of bytes in DOTM (Microsoft Office Open XML Macro-Enabled Template) format.
DotxBytesGets or sets the document content as an array of bytes in DOTX (Microsoft Office Open XML macro-free template) format.
DpiXGets the current dpi value for the X-coordinate.
DpiYGets the current dpi value for the Y-coordinate.
FlatOpcBytesGets or sets the document content as an array of bytes in FlatOpc (Microsoft Word XML Document, .xml) format.
FlatOpcMacroEnabledBytesGets or sets the document content as an array of bytes in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document, .xml) format.
FlatOpcMacroEnabledTemplateBytesGets or sets the document content as an array of bytes in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template, .xml) format.
FlatOpcTemplateBytesGets or sets the document content as an array of bytes in FlatOpcTemplate (Microsoft Word XML Template, .xml) format.
HtmlTextGets or sets the content as HTML text.
HyphenationDictionariesProvides access to the collection of hyphenation dictionaries.
IsPrintingAvailableMaintained for compatibility with the code written for the RichEditControl.
IsUpdateLockedReturns a value indicating whether the RichEditDocumentServer object is locked for update.
LayoutCalculationModeGets or sets the mode for layout calculation.
LayoutUnitGets or sets a unit of measure used for a document model layout.
MhtTextGets or sets the document content as MHT text.
ModelFor internal use.
ModifiedGets or sets a value that indicates that the document contents is modified since it was last saved.
OdtBytesGets or sets the document content as an array of bytes in Open Office Text (.odt) format.
OpenDocumentBytesGets or sets the document content as an array of bytes in Open Office Text (.odt) format.
OpenXmlBytesGets or sets the document content as an array of bytes in Office Open XML (Docx) format.
OptionsProvides access to the variety of options which can be specified for the RichEditDocumentServer.
RtfTextGets or sets the formatted text content of the document.
TextGets or sets the plain text content of the document.
UnitGets or sets a unit of measure used within the RichEditDocumentServer.
WordMLTextGets or sets the document content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format.

Methods

NameDescription
AddService(Type, ServiceCreatorCallback, Boolean)Adds the specified service to the service container.
AddService(Type, ServiceCreatorCallback)Adds the specified service to the service container.
AddService(Type, Object, Boolean)Adds the specified service to the service container.
AddService(Type, Object)Adds the specified service to the service container.
BeginInitialize()For internal use.
BeginUpdate()Locks the RichEditDocumentServer object until the RichEditDocumentServer.EndUpdate method is called.
CancelUpdate()For internal use. Use the RichEditDocumentServer.EndUpdate method instead.
CreateMailMergeOptions()Creates an object for specifying the options used in mail merge operations.
CreateNewDocument(Boolean)Creates a new blank document.
Dispose()Releases resources associated with a RichEditDocumentServer instance.
EndUpdate()Unlocks the RichEditDocumentServer object.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
ExportToPdf(Stream, PdfExportOptions)Exports the document to the specified stream in PDF format.
ExportToPdf(Stream)Exports the document to the specified stream in PDF format.
ExportToPdf(String, PdfExportOptions)Exports the content of the RichEditControl to the specified file path in PDF format, applying PDF-specific options.
ExportToPdf(String)Exports the document content to the specified file path in PDF format.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetService(Type)Gets the service object of the specified type.
GetService<T>()Gets the specified service.
GetType()Gets the Type of the current instance. Inherited from Object.
LoadDocument(Byte[], DocumentFormat, String)Loads a document in the specified format from a byte array. You can use this method to load HTML documents with connected files.
LoadDocument(Byte[], DocumentFormat)Loads a document in the specified format from a byte array.
LoadDocument(Byte[])Loads a document from a byte array. The file format is determined based on document content.
LoadDocument(Stream, DocumentFormat, String)Loads a document from the stream in the specified format. External content for HTML format is retrieved using the specified source (base) URI.
LoadDocument(Stream, DocumentFormat)Loads a document from a stream, specifying the document format.
LoadDocument(Stream)Loads a document from the stream.
LoadDocument(String, DocumentFormat, String)Loads a document from the file in the specified format. External content for HTML format is retrieved using the specified source (base) URI.
LoadDocument(String, DocumentFormat)Loads a document from a file, specifying the document format.
LoadDocument(String)Loads a document from the specified file. The file format is determined by its content.
LoadDocumentTemplate(Byte[], DocumentFormat)Loads a document template in the specified format from a byte array.
LoadDocumentTemplate(Byte[])Loads a document template from a byte array.
LoadDocumentTemplate(Stream, DocumentFormat)Loads a document template with specified format from a stream.
LoadDocumentTemplate(Stream)Loads a document template from the stream.
LoadDocumentTemplate(String, DocumentFormat)Loads a document template from the file in the specified format.
LoadDocumentTemplate(String)Loads a document template from the specified file.
MailMerge(Document)Merges data to the current document and sends the result to the specified Document instance.
MailMerge(MailMergeOptions, Document)Merges data to the current document and sends the result to the specified Document instance. Allows you to set the mail merge options.
MailMerge(MailMergeOptions, IRichEditDocumentServer)Obsolete. Merges the current document using the specified options and sends the result to the specified RichEditDocumentServer instance.
MailMerge(MailMergeOptions, Stream, DocumentFormat)Merges data to the current document and sends the result in the specified format to a stream. Allows you to set mail merge options.
MailMerge(MailMergeOptions, String, DocumentFormat)Merges data to the current document and saves the result to a file in the specified format. Allows you to set mail merge options.
MailMerge(IRichEditDocumentServer)Obsolete. Merges the current document and sends the result to the specified RichEditDocumentServer instance.
MailMerge(Stream, DocumentFormat)Merges data to the current document, and sends the result in the specified format to a stream.
MailMerge(String, DocumentFormat)Merges data to the current document and sends the result to a file in the specified format.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
Print()Prints the document to the default printer with the default settings.
Print(DXPrinterSettings, String)Prints the document specified by name with the specified cross-platform printer settings.
Print(DXPrinterSettings)Prints the document with the given cross-platform printer settings.
Print(PrinterSettings, String)Prints the document with the given printer settings and document name.
Print(PrinterSettings)Prints the document with the given printer settings.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RemoveService(Type, Boolean)Removes the service of the specified type from the service container.
RemoveService(Type)Removes the service of the specified type from the service container.
ReplaceService<T>(T)Performs a service substitution.
SaveDocument(DocumentFormat, EncryptionSettings)Saves the document to a byte array in the specified file format and encrypts it with a password.
SaveDocument(DocumentFormat)Saves the document to a byte array in the specified file format.
SaveDocument(Stream, DocumentFormat, EncryptionSettings)Saves the document to a stream, specifying the document’s format and encryption options.
SaveDocument(Stream, DocumentFormat)Saves the document to a stream, specifying the document’s format.
SaveDocument(String, DocumentFormat, EncryptionSettings)Saves the document to a file, specifying the document’s format and encryption options.
SaveDocument(String, DocumentFormat)Saves the control’s document to a file, specifying the document’s format.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
AfterExportOccurs after the document is successfully exported.
BeforeEncodingDetectionOccurs before detection of the loaded plain text or HTML encoding.
BeforeExportOccurs before the document is saved (exported to a certain format).
BeforeImportOccurs before a document is loaded (imported from an external source).
BeforePagePaintEnables you to specify a custom PagePainter descendant to alter the way the layout elements are drawn.
CalculateDocumentVariableFires when the DOCVARIABLE field is updated.
CommentInsertedOccurs after a new comment is created in the document.
ContentChangedOccurs when the document content was changed.
CustomPropertiesChangedOccurs when one of the DocumentCustomProperties has changed.
DecryptionFailedOccurs if the RichEditDocumentServer failed to open an encrypted file.
DocBytesChangedFor internal use.
DocmBytesChangedFor internal use
DocumentClosingOccurs when a document that has not yet been saved is about to be closed.
DocumentEncryptionChangedOccurs after one of the DocumentEncryption properties has been changed.
DocumentLoadedOccurs after a document is loaded.
DocumentPropertiesChangedOccurs after one of the DocumentProperties has changed.
DotBytesChangedFor internal use.
DotmBytesChangedFor internal use.
DotxBytesChangedFor internal use.
EmptyDocumentCreatedOccurs when a new document is created.
EncryptedFileIntegrityCheckFailedRaises when the encrypted file did not pass the data integrity verification.
EncryptedFilePasswordCheckFailedOccurs when the encryption password is empty or invalid.
EncryptedFilePasswordRequestedRaises when the RichEditDocumentImportOptions.EncryptionPassword property is not set or returns an invalid password.
FlatOpcBytesChangedFor internal use.
FlatOpcMacroEnabledBytesChangedFor internal use.
FlatOpcMacroEnabledTemplateBytesChangedFor internal use.
FlatOpcTemplateBytesChangedFor internal use.
HtmlTextChangedFor internal use.
InitializeDocumentOccurs before a document is loaded. Handle this event to set initial document settings.
InvalidFormatExceptionFires when the supplied data could not be recognized as data in the assumed format for import.
MailMergeFinishedFires when mail merge is completed.
MailMergeRecordFinishedFires after each data record is merged with the document in the mail merge process.
MailMergeRecordStartedFires before each data record is merged with the document in the mail merge process.
MailMergeStartedFires before mail merge starts.
MhtTextChangedFor internal use.
ModifiedChangedOccurs when the value of the RichEditDocumentServer.Modified property is changed.
OpenDocumentBytesChangedFor internal use.
OpenXmlBytesChangedFor internal use.
RtfTextChangedFor internal use.
SelectionChangedFires in response to changing a selection in the document.
TrackedMovesConflictOccurs when moved text has been changed since it was moved.
UnhandledExceptionThis event is raised when an exception unhandled by the RichEditDocumentServer occurs.
WordMLTextChangedFor internal use.

See Also

RichEditDocumentServer Class

DevExpress.XtraRichEdit Namespace