Contains classes, structures, enumerations and interfaces which constitute GemBox.Document object model.
Classes
| Class | Description | |
|---|---|---|
| Block | ||
| BlockCollection |
Represents a collection of a Block derived elements.
| |
| Bookmark |
Represents the bookmark (pair of BookmarkStart and BookmarkEnd elements).
| |
| BookmarkCollection |
Represents a collection of Bookmarks.
| |
| BookmarkEnd |
Represents the end of a bookmark.
| |
| BookmarkStart |
Represents the start of a bookmark.
| |
| BuiltInDocumentPropertiesDictionary |
Represents a dictionary that contains BuiltInDocumentProperty key and String value pairs.
| |
| CharacterFormat |
Represents a set of formatting properties which shall be applied to a document text.
| |
| CharacterStyle | ||
| ComponentInfo |
Contains static licensing methods and diagnostic information about executing GemBox.Document assembly.
| |
| CustomDocumentPropertiesDictionary | ||
| DictionaryBase TKey, TValue |
Provides a base class for generic dictionary.
| |
| DocumentModel |
Represents a document.
| |
| DocumentModelPage |
Represents a document page.
| |
| DocumentModelPaginator |
Provides a functionality to paginate the document content.
| |
| DocumentProperties |
Contains a dictionaries of built-in and custom document properties.
| |
| DocxLoadOptions |
Represents a class that stores loading options for Microsoft Word (DOCX) format.
| |
| DocxSaveOptions |
Represents a class that stores saving options for Microsoft Word file.
| |
| Element |
Represents a base class for all document elements.
| |
| ElementCollection |
Represents a base non-generic class for Element collections.
| |
| ElementCollection T |
Represents a base generic class for Element collections.
| |
| Field |
Provides a mechanism for placeholders, such as page reference numbers, which can be added to a document
such that those placeholders are replaced by their corresponding values when the document is rendered for display or print.
| |
| FontSettings |
Contains font related settings which are used when printing a document or exporting a document to a file format that requires font information.
| |
| Format |
Represents a base class for all formattings.
| |
| FreeLimitEventArgs |
Provides data for the FreeLimitReached event.
| |
| FreeLimitReachedException |
Exception that occurs when free limit is reached.
| |
| HeaderFooter |
Represent a header / footer for the parent Section.
| |
| HeaderFooterCollection |
Represents a collection of HeaderFooter elements.
| |
| HtmlSaveOptions |
Represents options for saving to HyperText Markup Language (HTML) format.
| |
| Hyperlink | ||
| ImageSaveOptions |
Represents a class which stores saving options for image files.
| |
| Inline |
Represents a base class for all inline elements, like Run, Picture, Hyperlink, Field, BookmarkStart, BookmarkEnd, SpecialCharacter and PreservedInline.
| |
| InlineCollection |
Represents a collection of Inline derived elements.
| |
| LengthUnitConverter |
Utility class used for converting values between various LengthUnit measurement units.
| |
| ListFormat |
Represents list format which shall be applied to the contents of the parent paragraph.
| |
| ListLevelFormat |
Represents formatting definition for one list level.
| |
| ListLevelFormatCollection |
Represents a read-only collection of list level formatting.
| |
| ListStyle |
Represents a list style which can be applied to one or more Paragraphs within document content.
| |
| LoadOptions |
Represents a base class for loading options of various file formats. For now, only derived class is DocxLoadOptions.
| |
| MultipleBorders |
Represents a set of borders.
| |
| PageMargins |
Represents page margins.
| |
| PageSetup |
Represents the page setup properties of a Section.
| |
| Paragraph |
Represents a paragraph of content in the document.
| |
| ParagraphFormat |
Represents a set of paragraph formatting properties which shall be applied to the contents of the parent paragraph.
| |
| ParagraphStyle |
Represents a style which can be applied to one or more Paragraphs within a document content.
| |
| PdfSaveOptions |
Represents a class that stores saving options for Portable Document Format (PDF) file.
| |
| Picture |
Represents a picture.
| |
| PreservedInline |
Represents an Inline element that is loaded from a file and is not directly supported by GemBox.Document API.
| |
| PrintOptions |
Specifies information about how a document is printed.
| |
| Run |
Represents a region of text with a common set of properties.
| |
| SaveOptions |
Represents a base class for saving options of various file formats.
| |
| Section | ||
| SectionCollection |
Represents a collection of Section elements.
| |
| SpecialCharacter |
Represents a character, such as break or tab, which shall be placed at the current location in the document content.
| |
| Style |
Represents a style.
| |
| StyleCollection |
Represents a collection of Styles.
| |
| TableOfEntries |
Represents a Table of Entries field, such as Table of Contents, Table of Figures, Table of Authorities, Index or Bibliography.
| |
| TabStopCollection |
Represents a set of TabStops.
| |
| TextColumn |
Represents a column in a Section.
| |
| TextColumnCollection |
Represents a collection of TextColumns in a Section.
| |
| ViewOptions |
Represents the view options for the DocumentModel. Supported only in DOCX format.
| |
| XpsSaveOptions |
Represents a class that stores saving options for XML Paper Specification (XPS) file.
|
Structures
| Structure | Description | |
|---|---|---|
| Color |
Represents a color.
| |
| HorizontalPosition |
Represents a horizontal positioning which can be expressed with HorizontalPositionType enumeration or Double value.
| |
| Padding |
Represents the space between the element border and the element content.
| |
| SingleBorder |
Represents a single border around a document element.
| |
| TabStop |
Represents a single custom tab stop within a set of custom tab stops applied at ParagraphFormat.Tabs property.
| |
| VerticalPosition |
Represents a vertical positioning which can be expressed with VerticalPositionType enumeration or Double value.
|
Interfaces
| Interface | Description | |
|---|---|---|
| IContentElement |
Enumerations
| Enumeration | Description | |
|---|---|---|
| BorderStyle |
Specifies line style for a border.
| |
| BuiltInDocumentProperty |
Enumeration of available built-in document properties.
| |
| DocxFormat |
An enumeration of Microsoft Word file formats.
| |
| ElementType |
Represents an element type enumeration.
| |
| FieldType |
Represents a field type that is used in defining Fields.
| |
| FreeLimitReachedAction |
Type of action that can be chosen when free limit is reached.
| |
| HeaderFooterType |
Specifies the type of the HeaderFooter.
| |
| HorizontalAlignment |
Horizontal alignment.
| |
| HorizontalPositionAnchor |
Represents a horizontal position to which the parent object has been anchored in the document.
This anchor position shall be used as the base location to determine the final horizontal position of the object in the document.
| |
| HorizontalPositionType |
Represents a set of possible relative horizontal positions for the parent floating object.
This relative position is specified relative to the horizontal anchor specified by the parent object.
| |
| HtmlType |
Defines type of HTML export.
| |
| ImageSaveFormat |
An enumeration of supported image file formats when saving a document's page to an image using a ImageSaveOptions.
| |
| LengthUnit |
Represents the measurement unit for measuring length or distance.
| |
| LineNumberRestartSetting |
Represents line number restart setting.
| |
| LineSpacingRule |
Specifies line spacing rule for a paragraph.
| |
| ListTemplateType |
Specifies one of the predefined list formats.
| |
| ListTrailingCharacter |
Specifies trailing character that will be inserted after the number.
| |
| MultipleBorderTypes |
Represents multiple border types.
| |
| NumberStyle |
Represents the number style.
| |
| Orientation |
Represents a page layout orientation.
| |
| OutlineLevel |
Specifies the outline level.
| |
| PaperType |
Specifies the paper type.
| |
| PictureFormat |
Represents the file format for an image contained in PictureStream.
| |
| SectionStart |
Represents a type of section start that is used in defining SectionStart.
| |
| SingleBorderType |
Represents single border type.
| |
| SpecialCharacterType |
Represents the type of the SpecialCharacter.
| |
| StyleTemplateType |
Type that determines predefined style.
| |
| StyleType |
Represents a style type enumeration.
| |
| TabStopAlignment | ||
| TabStopLeader |
Represents the characters which may be used to fill in the space created by a tab which ends at this custom TabStop.
The chosen character shall be repeated as required to completely fill the tab spacing generated by the tab character.
| |
| TextWrappingStyle |
Specifies how text is wrapped around a picture.
| |
| UnderlineType |
Represents the types of patterns which may be used to create the underline applied beneath the text in a Run.
| |
| VerticalAlignment |
Represents a vertical alignment for text or picture between the top and bottom margins of the parent element.
| |
| VerticalPositionAnchor |
Represents a vertical position to which the parent object has been anchored in the document.
This anchor position shall be used as the base location to determine the final vertical position of the object in the document.
| |
| VerticalPositionType |
Represents a set of possible relative vertical positions for the parent floating object.
This relative position is specified relative to the vertical anchor specified by the parent object.
| |
| ViewType |
Represent view type.
| |
| WrapTextType |
Specifies how text shall wrap around the object's left and right sides.
|