GemBox.Document Represents an alignment tab, also called an absolute position tab (ptab). An absolute position tab is a character which is used to advance the position on the current line of text based on its and properties. The resulting end position of the tab character is not affected by the addition of any custom tab stops or changes to the value of the default tab stop. Initializes a new instance of the . The owner document. The alignment of the tab. The only valid values for AlignmentTab are , and . Gets or sets the character format. The character format. Gets or sets the revision of the format of this AlignmentTab. This property contains the format which was applied to this AlignmentTab before the revision. The revision of the format of this AlignmentTab. The revision is internally stored as a member of . Using set property on overrides this revision. Gets or sets the character which shall be used to fill in the space created by a tab which ends at this position. The character which shall be used to fill in the space created by a tab which ends at this position. Gets or sets the alignment of the current , which determines the alignment that will be applied to text entered at the current position. The alignment of the current . The only valid values for AlignmentTab are , and . Gets or sets a value that specifies the base position which should be used to align the tab. The base position which should be used to align the tab. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a base class for all block elements - , and . Block elements take the entire width of a document. No other document element can be contained in the same line with a block element. Block elements, especially s, are starting building blocks for , , and content. For more information, see GemBox.Document Content Model. GemBox.Document Content Model Gets the that contains this instance. The that contains this instance. Clones this instance. If set to clones all descendants recursively; otherwise clones only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a collection of a derived elements. Although is a strongly typed collection of a derived elements, not all derived elements are supported in every . For example, TableOfEntries.Entries supports only elements; TableCell.Blocks and HeaderFooter.Blocks support and elements; and Section.Blocks supports all derived elements. Supported element types can be retrieved through property. For more information, see GemBox.Document Content Model. GemBox.Document Content Model Represents the bookmark (pair of and elements). A object serves as a façade for and elements. objects can be retrieved from DocumentModel.Bookmarks collection. DocumentModel.Bookmarks collection contains all bookmarks in the document. Use DocumentModel.Bookmarks collection to retrieve a with a specified name, iterate over all bookmarks or remove a bookmark. Bookmarks are usually used in a conjunction with s or s for navigating to a bookmarked part of the document or to render a page number (or some other information) of a bookmarked part of the document. For more information, see Bookmarks and Hyperlinks and Modify Bookmarks examples. Gets the bookmark name. The bookmark name. Gets the element. The element. Gets the element. The element. Gets the content of the current . if set to , returned will also contain Bookmark.Start and Bookmark.End elements, otherwise it won't. The content of the current . Following table explains how parameter value affects on the behavior of methods of the returned :
is is
ContentRange.Delete methodDeletes content between Bookmark.Start and Bookmark.End,
leaving the Bookmark.Start and Bookmark.End in the document.		Deletes content between Bookmark.Start and Bookmark.End,
removing the Bookmark.Start and Bookmark.End from the document,
thus removing the current from the document (DocumentModel.Bookmarks collection).
ContentRange.LoadText and ContentRange.Set methodsSets new bookmarked content,
leaving the Bookmark.Start and Bookmark.End in the document.		Sets new bookmarked content,
removing the Bookmark.Start and Bookmark.End from the document,
thus removing the current from the document (DocumentModel.Bookmarks collection).
For more information, see modify bookmarks example. This method is obsolete. Use Bookmark.GetContent(false). method instead. Sets content between and elements. New content. This method is obsolete. Use Bookmark.GetContent(false). method instead. Sets content between and elements. New content. This method is obsolete. Use Bookmark.GetContent(false). method instead. Sets content between and elements. New content. This method is obsolete. Use Bookmark.GetContent(true). method instead. Removes and elements and replaces content between them with new content. New content. This method is obsolete. Use Bookmark.GetContent(true). method instead. Removes and elements and replaces content between them with new content. New content. This method is obsolete. Use Bookmark.GetContent(true). method instead. Removes and elements and replaces content between them with new content. New content. Represents a collection of s. is used in a DocumentModel.Bookmarks property. DocumentModel.Bookmarks collection contains all bookmarks in the document. Use DocumentModel.Bookmarks collection to retrieve a with a specified name, iterate over all bookmarks or remove a bookmark. Bookmarks are usually used in a conjunction with s or s for navigating to a bookmarked part of the document or to render a page number (or some other information) of a bookmarked part of the document. For more information, see Bookmarks and Hyperlinks example. Removes the element at the specified index of the . The zero-based index of the element to remove. Removes the first occurrence of a specific element from the . The element from the . true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the . Removes all elements from the . Gets the at the specified index. The at the specified index. The zero-based index of the to get. The at the specified index. Gets the with the specified name. The with the specified name. The name of the bookmark to get. The with the specified name, or if with specified name doesn't exist in the document. Searches for the specified element and returns the zero-based index of the first occurrence within the entire . The element to locate in the . The zero-based index of the first occurrence of item within the entire , if found; otherwise, -1. Determines whether an element is in the . The element to locate in the . true if item is found in the ; otherwise, false. Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. The one-dimensional array that is the destination of the elements copied from . The zero-based index in array at which copying begins. Gets the number of s contained in the . The number of s contained in the . Returns an enumerator that iterates through the . An enumerator for the . Represents the end of a bookmark. element is used in a pair with element to bookmark a specific part of the document with a specific name. For and to be considered as a pair, their names must match. is an inline element. For more information about GemBox.Document document content model, see Content Model. To easily navigate and manipulate over all bookmarks in the document, GemBox.Document also contains a class that serves as a façade for and elements. objects can be retrieved from DocumentModel.Bookmarks collection. Bookmarks are usually used in a conjunction with s or s for navigating to a bookmarked part of the document or to render a page number (or some other information) of a bookmarked part of the document. For more information, see Bookmarks and Hyperlinks and Modify Bookmarks examples. Initializes a new instance of the class. The owner document. The bookmark name. Gets the name of this bookmark. The name of this bookmark. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents the start of a bookmark. element is used in a pair with element to bookmark a specific part of the document with a specific name. For and to be considered as a pair, their names must match. is an inline element. For more information about GemBox.Document document content model, see Content Model. To easily navigate and manipulate over all bookmarks in the document, GemBox.Document also contains a class that serves as a façade for and elements. objects can be retrieved from DocumentModel.Bookmarks collection. Bookmarks are usually used in a conjunction with s or s for navigating to a bookmarked part of the document or to render a page number (or some other information) of a bookmarked part of the document. For more information, see Bookmarks and Hyperlinks and Modify Bookmarks examples. Initializes a new instance of the class. The owner document. The bookmark name. Gets the name of this bookmark. The name of this bookmark. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Specifies line style for a border. is specified when creating a new and assigning it to a CharacterFormat.Border property, or when setting a multiple borders through on ParagraphFormat.Borders, TableFormat.Borders or TableCellFormat.Borders properties. Supported values in PDF, XPS, and image formats: No border. Single line border. Double line border. Triple line border. Dotted line border. Dashed line border. Dot - dash line border. Dot - dot - dash line border. Wave line border. Double wave line border. Outset set of line borders. Inset set of line borders. Dash with small gap line borders. Thick - thin with large gap line borders. Thick - thin with medium gap line borders. Thick - thin with small gap line borders. Thin - thick with large gap line borders. Thin - thick with medium gap line borders. Thin - thick with small gap line borders. Thin - thick - thin with large gap line borders. Thin - thick - thin with medium gap line borders. Thin - thick - thin with small gap line borders. Dash - dot stroked line border. 3D embossed line border. 3D engraved line border. Represents a dictionary that contains key and value pairs. values cannot be or . Built-in and custom document properties are contained in class which is used in DocumentModel.DocumentProperties property. For more information, see document properties example. Enumeration of available built-in document properties. enumeration is used as a keys in dictionary. Built-in and custom document properties are contained in class which is used in DocumentModel.DocumentProperties property. For more information, see document properties example. Title of the document. Name of the document's author. Subject of the document. Document comments. UTC time of creation of the document. UTC time on which the document was last modified/saved. Category of the document. Status of the document. Document keywords. Name of the last author. Manager. Company. Base hyperlink. Application. UTC time on which the document was last printed. Document revision number. Represents the detailed description of fonts which shall be used to display the text of the run. Gets or sets the name of the font which shall be used to format all characters in the Unicode code point range (U+0000–U+007F) within the text of the run. The name of the font. Gets or sets the name of the font which shall be used to format characters within the text of the run which do not fall into the range specified by , , or . The name of the font. Gets or sets the name of the font which shall be used to format all characters in an East Asian Unicode code point range within the text of the run. The name of the font. Gets or sets the name of the font which shall be used to format all Complex Script (mainly Arabic) characters within the text of the run. The name of the font. Determines whether the specified is equal to this instance. The to compare with this fonts instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first fonts. The second fonts. if and fonts are equal; otherwise, . Determines whether and  s are not equal. The first fonts. The second fonts. if and fonts are not equal; otherwise, . Represents a set of formatting properties which shall be applied to a document text. GemBox.Document supports a variety of text formatting options like font name, size and color; on / off properties like bold, italic, underline, strikethrough, subscript, superscript and many others. can be set on: elements , and ;styles and ;DocumentModel.DefaultCharacterFormat and ListLevelFormat.CharacterFormat properties.For more information about properties, see character formatting example. GemBox.Document Formats and Styles Initializes a new instance of the class. Gets or sets the character style. The character style. Gets or sets a value indicating whether the text of the run shall be displayed with a single horizontal line through the center of the line. if the text of the run shall be displayed with a single horizontal line through the center of the line; otherwise, . Gets or sets a value indicating whether the text of the run shall be displayed with two horizontal lines through each character displayed on the line. if the text of the run shall be displayed with two horizontal lines through each character displayed on the line; otherwise, . Gets or sets a value indicating whether the text of the run shall be repositioned as superscript. if the text of the run shall be repositioned as superscript; otherwise, . Gets or sets a value indicating whether the text of the run shall be repositioned as subscript. if the text of the run shall be repositioned as subscript; otherwise, . Gets or sets a value indicating whether all small letter characters in the text run shall be formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for the text. if all small letter characters in the text run shall be formatted for display only as their capital letter character equivalents in a font size two points smaller than the actual font size specified for the text; otherwise, . Gets or sets a value indicating whether to display all characters as capital letters. to display all characters as capital letters; otherwise, . Gets or sets a value indicating whether the text of the run shall be hidden from display at display time in a document. if the text of the run shall be hidden from display at display time in a document; otherwise, . Gets or sets a value indicating whether all characters in the text of the run are bold. if all characters in the text of the run are bold; otherwise, . Gets or sets a value indicating whether all characters in the text of the run are italic. if all characters in the text of the run are italic; otherwise, . When true, the contents of this run shall have right-to-left reading order. if the contents of this run shall have right-to-left reading order.; otherwise, . Gets or sets the font size (in points) which shall be applied to the text of the run when displayed. The font size which shall be applied to the text of the run when displayed. Gets or sets the name of the font which shall be used to display the text of the run. If this property is or then theme font will be used (theme font for freshly created document is Calibri). The name of the font which shall be used to display the text of the run. Gets a detailed description of the fonts used to display the text of the run. The detailed description of the fonts used to display the text of the run. This property provides fine-grained support for getting and setting different fonts for different Unicode character ranges in a single run. In the vast majority of cases, a single font is used to display all characters of the run and the property can be used instead. Gets or sets the pattern which shall be used to create the underline applied beneath the text in the run. The pattern which shall be used to create the underline applied beneath the text in the run. Gets or sets the color which shall be used to display the text of the run. The color which shall be used to display the text of the run. Gets or sets a highlighting color which is applied as a background behind the text of the run. overrides . A highlighting color which is applied as a background behind the text of the run. Highlighting color must be one of the following: Gets or sets the text background color. overrides . The text background color. Gets or sets the color for the underlining on the run. The color for the underlining on the run. Gets or sets the smallest font size which shall have its kerning automatically adjusted. If the is smaller than this value, then no font kerning shall be performed. The smallest font size which shall have its kerning automatically adjusted. Gets or sets the amount of character pitch in points which shall be added or removed after each character in the run before the following character is rendered in the document. The amount of character pitch in points which shall be added or removed after each character in the run before the following character is rendered in the document. Gets or sets the amount in points by which text shall be raised or lowered for the run in relation to the default baseline of the surrounding non-positioned text. The amount in points by which text shall be raised or lowered for the run in relation to the default baseline of the surrounding non-positioned text. If the value is positive, then the parent run shall be raised above the baseline of the surrounding text by the specified number of points. If the value is negative, then the parent run shall be lowered below the baseline of the surrounding text by the specified number of points. Gets or sets the percentage by which each character shall be expanded or compressed when the character is rendered in the document. Supported only in DOCX and DOC formats. The percentage by which each character shall be expanded or compressed when the character is rendered in the document. Gets or sets the border of the that has this applied to it. Supported only in DOCX and DOC formats. The border of the that has this applied to it. This value is currently ignored when exporting a document to PDF, XPS, or image formats. Gets or sets the language information. The which will be used for defining culture specific formatting. Default value is . Gets or sets the form in which to display numeral spacing. The form in which to display numeral spacing. Default value is . Determines whether the specified is equal to this instance. The to compare with this character format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first character format. The second character format. if and character formats are equal; otherwise, . Determines whether and  s are not equal. The first character format. The second character format. if and character formats are not equal; otherwise, . Clones this instance. Cloned . Clones this . If , the values to be cloned will be fetched from this object's resolved values. This means that even if a property was never explicitly set, this method will look into this format style or in the document's default formats to resolve the values and explicitly set them in the cloned object. Cloned . Represents a style which can be applied to a , or elements. Styles provide a way to format your document in a consistent way so when you change your formatting options on a style, all document elements referencing that style will be changed. To apply a to a , set it to a CharacterFormat.Style property on a Run.CharacterFormat. For an example how to apply to a , see styles example. GemBox.Document Formats and Styles Initializes a new instance of the class with specified name. The character style name. Gets or sets the character format which shall be applied to the referencing . The character format which shall be applied to the referencing . For more information about paragraph formatting, see character formatting example. Gets or sets the style on which this style is based. The base style. Represents a chart. Chart is a that represents data in graphical form. In order to create, edit, or export charts, the GemBox.Spreadsheet library needs to be loaded. Without it, charts will be preserved instead of being loaded into the . For more information, see charts example. GemBox.Document Content Model Charts example Gets the actual chart as an instance of GemBox.Spreadsheet.Charts.ExcelChart. The actual chart as an instance of GemBox.Spreadsheet.Charts.ExcelChart. Initializes a new instance of the class with specified data and layout. The owner document. Type of the chart. The chart's series grouping (clustered, stacked or 100% stacked). The chart layout (position and size). Initializes a new instance of the class with specified data and layout. The owner document. Type of the chart. The chart layout (position and size). Initializes a new instance of the class with specified data. The owner document. Type of the chart. The chart's series grouping (clustered, stacked or 100% stacked). Initializes a new instance of the class with specified data. The owner document. Type of the chart. Gets the element type for which is . The value. Gets the of this instance. The of this instance. Clones this instance. Cloned . Represents the grouping of a chart series for each category in a chart. Chart series are drawn on the value axis. Not applicable for ColumnChart and BarChart. Chart series are drawn next to each other along the category axis. Applicable only for ColumnChart and BarChart. Chart series are drawn next to each other on the value axis. Use it to compare the contribution of each value to a total across categories. This value is currently supported only by ColumnChart and BarChart when exporting a chart to PDF, XPS, or image formats. This value is exported as for all other chart types. Chart series are drawn next to each other along the value axis and scaled to total 100%. Use it to compare the percentage that each value contributes to a total across categories. This value is currently supported only by ColumnChart and BarChart when exporting a chart to PDF, XPS, or image formats. This value is exported as for all other chart types. Represents a chart type. Chart type whose series values are drawn using vertical rectangles. Chart type whose series values are drawn using horizontal rectangles. Chart type whose series values are drawn using lines. Chart type whose series values are drawn using filled areas. Chart type whose single series values are drawn as filled arcs in a pie-like form. Chart type which combines different chart types in a single chart. Chart type whose series x and y values are drawn using lines. Chart type whose series values are drawn as filled arcs in a doughtnut-like form. Chart type whose series are drawn as lines or filled areas in a radar-like form. Represents a color. Represents an empty color (RGB = 0x000000). Represents a write color (RGB = 0xFFFFFF). Represents a black color (RGB = 0x000000). Represents a blue color (RGB = 0x0000FF). Represents a brown color (RGB = 0xA52A2A). Represents a gray color (RGB = 0x808080). Represents a green color (RGB = 0x00FF00). Represents an orange color (RGB = 0xFFA500). Represents a pink color (RGB = 0xFFC0CB). Represents a purple color (RGB = 0x800080). Represents a red color (RGB = 0xFF0000). Represents a yellow color (RGB = 0xFFFF00). Represents a cyan color (RGB = 0x00FFFF). Represents a dark blue color (RGB = 0x000080). Represents a dark cyan color (RGB = 0x008080). Represents a dark gray color (RGB = 0x808080). Represents a dark green color (RGB = 0x008000). Represents a dark magenta color (RGB = 0x800080). Represents a dark red color (RGB = 0x800000). Represents a dark yellow color (RGB = 0x808000). Represents a light gray color (RGB = 0xC0C0C0). Represents a magenta color (RGB = 0xFF00FF). Initializes a new instance of the struct. The red component. The green component. The blue component. Initializes a new instance of the struct. The integer that represents the color in the format [__,RR,GG,BB] where RR is the byte that represents the red component, GG is the byte that represents the green component and BB is the byte that represents the blue component. Gets the red component of this instance. The red component of this instance. Gets the green component of this instance. The green component of this instance. Gets the blue component of this instance. The blue component of this instance. Gets a value indicating whether this instance is empty. if this instance is empty; otherwise, . Determines whether the   is equal to this instance. The other color to compare with this color instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this color instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first color. The second color. if and colors are equal; otherwise, . Determines whether and  s are not equal. The first color. The second color. if and colors are not equal; otherwise, . Contains methods that can be useful for users which are calling GemBox.Document component using COM interop. Initializes a new instance of the class. Call this method from your application to set GemBox.Document serial key. The serial key. You should call this method before using any other class from GemBox.Document assembly. Key can only be set once (if you try another key, exception will be thrown). The best place to call this method is from static constructor of your application's main class. Valid serial key has multiple groups of alphanumeric characters, separated with dashes. To use the assembly in free limited mode use FREE-LIMITED-KEY as . For more information about GemBox.Document evaluation and licensing, see evaluation and licensing. Loads a document from a file with the specified path. The path from which to load a document. A loaded document. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension that is extracted from the is used to create the appropriate derived class instance that is then passed to the method. Following file extensions are supported:Microsoft Word: .docx, .docm, .dotm, .dotxMicrosoft Word 97-2003: .doc, .dotOpenDocument Text: .odtPortable Document Format: .pdfHyperText Markup Language: .htm, .html, .mht, .mhtmlExtensible Markup Language (Flat OPC and WordML): .xmlRich Text Format: .rtfPlain Text: .txt Open and read Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Loads a document from a file with the specified path. The path from which to load a document. The loading options which can be used to define settings for load operation. A loaded document. Open and read Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Saves the document to a file with the specified path. The DocumentModel instance which to save. The path to which to save the document. The saving options which can be used to define settings for save operation. Create and write to Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets the parent's child elements filtered by . The parent element. to get all descendants elements; otherwise to get just child elements. The to filter by. Array of child elements filtered by . Iterating example Gets the number of elements contained in the . The instance. The number of elements contained in the . Gets the from at the specified index. The instance. The zero-based index of the to get. The at the specified index. Removes the at the specified index. The instance. The zero-based index of the to remove. Represents a comment that is anchored to a region of document content. Creates the new instance of the class The owner document. Gets or sets the initials of the author of the current comment. The initials of the author of the current comment. Gets or sets the author of the current comment. The author of the current comment. Gets or sets the date of the current comment. The date of the current comment. Gets or sets whether the comment was marked as resolved. True if comment is resolved, false otherwise. Gets or sets the comment to which this comment is a reply. The comment to which this comment is a reply. Gets the content of the comment. The content of the comment. Gets the element that marks the start of this comment. The start of this comment. Gets the element that marks the end of this comment. The end of this comment. Represents a collection of s. is used in a DocumentModel.Comments property. DocumentModel.Comments collection contains all bookmarks in the document. Use DocumentModel.Comments collection to retrieve a , iterate over all comments or remove a comment. Removes the first occurrence of a specific element from the . The element from the . true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the . Gets the at the specified index. The at the specified index. The zero-based index of the to get. The at the specified index. Searches for the specified element and returns the zero-based index of the first occurrence within the entire . The element to locate in the . The zero-based index of the first occurrence of item within the entire , if found; otherwise, -1. Determines whether an element is in the . The element to locate in the . true if item is found in the ; otherwise, false. Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. The one-dimensional array that is the destination of the elements copied from . The zero-based index in array at which copying begins. Returns an enumerator that iterates through the . An enumerator for the . Represents the end of a comment. element is used in a pair with element to mark the region of the comment. Creates the new instance of the class The owner document. The comment that this element delimits. Gets the comment that this element delimits. The parent comment. Represents the start of a comment. element is used in a pair with element to mark the region of the comment. Creates the new instance of the class The owner document. The comment that this element delimits. Gets the comment that this element delimits. The parent comment. Contains static licensing methods and diagnostic information about executing GemBox.Document assembly. Occurs in loading or saving when GemBox.Document assembly is used with FREE-LIMITED-KEY license key and free limit is reached. This event is raised when GemBox.Document assembly is used with FREE-LIMITED-KEY license key and maximum number of paragraphs per document is reached (20 paragraphs). Free mode will read / write first 20 paragraphs normally and, if document has more than 20 paragraph, it will throw .You can use this event to continue using the assembly in a trial mode for performance testing (set to ) or to stop further reading/writing (set to ). Trial mode will: read all document content but will insert word "TRIAL" on random places in the document.write all document content but will insert custom promotional header to all pages that come after 20th paragraph.For more information about GemBox.Document evaluation and licensing, see evaluation and licensing. Gets GemBox.Document assembly title. GemBox.Document assembly title. Gets GemBox.Document assembly full version. GemBox.Document assembly full version. Sets the license (serial) key. The serial key. You should call this method before using any other class from GemBox.Document assembly. Key can only be set once (if you try another key, it will be ignored). The best place to call this method is from static constructor of your application's main class. Valid serial key has multiple groups of alphanumeric characters, separated with dashes. To use the assembly in free limited mode use FREE-LIMITED-KEY as . For more information about GemBox.Document evaluation and licensing, see evaluation and licensing. Represents an arbitrary content that is either embedded in or linked to the document file. Gets the media type of the content. This value can be if the content is not embedded in but is linked to the document file. The media type of the content. Media type Gets the location of the content that is not embedded in the document file. The location of the content that does not reside within the document file. Gets a value indicating whether this content is linked to the document file. if this content is linked to the document file; otherwise, . Opens the content as a . Make sure to call on the returned instance after it is no longer used and before it gets out of scope. An instance of a type that represents content data. If content is linked to the documentation file ( property is not ), this method might attempt to open an external content. This operation might fail if the value is not in the correct format or if executing code doesn't have permissions to access content at the location specified in the value. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents a position within a . For more information, see content manipulation examples. Content manipulation examples Gets the parent that scopes the current . The parent that scopes the current . Inserts the content of the specified at the current . The which content should be inserted at the current . A instance which points to a location just after the inserted content. For more information, see Insert Content example. Insert HTML and RTF content to Word file in C# and VB.NET Loads the specified text at the current . The text which should be loaded at the current . A instance which points to a location just after the loaded text. For more information, see Insert Content example. Insert HTML and RTF content to Word file in C# and VB.NET Loads the specified text with specific formatting at the current . The text which should be loaded at the current . The formatting of the text which should be loaded at the current . A instance which points to a location just after the loaded text. For more information, see Insert Content example. Insert HTML and RTF content to Word file in C# and VB.NET Loads the specified text at the current . The text which should be loaded at the current . The options used to define settings for load operation. A instance which points to a location just after the loaded text. For more information, see Insert Content example. Insert HTML and RTF content to Word file in C# and VB.NET Loads the specified HTML text at the current . The HTML text which should be loaded at the current . The options used to define settings for load operation. A instance which points to a location just after the loaded HTML text. For more information, see Word Editor in ASP.NET and Insert Content example. Word Editor in ASP.NET Insert Content example Loads the specified RTF text at the current . The RTF text which should be loaded at the current . The options used to define settings for load operation. A instance which points to a location just after the loaded RTF text. Loads the specified Markdown text at the current . The Markdown text which should be loaded at the current . The options used to define settings for load operation. A instance which points to a location just after the loaded Markdown text. Loads the content of the clipboard at the current using specified text format. List of type derivations mapping clipboard text formats. type derivation supplied inside is not supported for this operation. Use one of the supported derivations: , and Applications which load data from clipboard should try to load it using the richest text format it supports. Following type derivations can be used: , and . If no is specified, content is loaded using first supported type derivation which successfully completed, trying in following order: -> -> . Loads the content of the clipboard at the current using specified text format. List of type derivations mapping clipboard text formats. type derivation supplied inside is not supported for this operation. Use one of the supported derivations: , and Applications which load data from clipboard should try to load it using the richest text format it supports. Following type derivations can be used: , and . This method is obsolete. Use ContentPosition.LoadText(string) method instead. Inserts the specified text at the current . The text which should be inserted at the current . A instance which points to a location just after the inserted text. For more information, see Insert Content example. Insert HTML and RTF content to Word file in C# and VB.NET This method is obsolete. Use ContentPosition.LoadText(string, CharacterFormat) method instead. Inserts the specified text at the current . The text which should be inserted at the current . The formatting of the text which should be inserted at the current . A instance which points to a location just after the inserted text. For more information, see Insert Content example. Insert HTML and RTF content to Word file in C# and VB.NET Represents the method that is called for each that is found during a Replace method operation. The that is found during a Replace method operation. The instance that should replace the found . Represents a contiguous area in a document between two s. is defined by a starting and ending . Similar to the way s are used in a document, instances are used to identify specific portions of a document. However, unlike a , a instance only exists while the programming code that defined it is running. enables to view the document as a contiguous sequence of characters by hiding the complexity of the underlying hierarchical content model. offers following functionalities: Delete part of the document content with ContentRange.Delete method.Set new content to a part of the document content with ContentRange.LoadText and ContentRange.Set methods.Insert new content before or after a part of the document content with ContentRange.Start. (or ContentRange.Start.LoadText) and ContentRange.End. (or ContentRange.End.LoadText) methods.Find or replace all parts of the document content which match the specified string or specified with ContentRange.Find or ContentRange.Replace methods.Export part of the document content to a textual format with ContentRange.ToString method. is exposed on following members: Element.Content property so that all -derived classes from GemBox.Document Content Model have it. ElementCollection.Content property so that all collection properties from GemBox.Document Content Model have it (for example, Section.Blocks or Paragraph.Inlines). Bookmark.GetContent(System.Boolean) method so that bookmarked content can be set, deleted, searched etc. For more information, see content manipulation examples. Content manipulation examples Gets the that marks the beginning of the current . The that marks the beginning of the current . Gets the that marks the end of the current . The that marks the end of the current . Initializes a new instance of the class. The that marks the beginning of the new . The that marks the end of the new . Argument or is . Arguments and do not belong to the same document. Gets the snapshot of form fields data for all form fields in the current range. The snapshot of form fields data for all form fields in the current range. This property returns a snapshot of form fields data for all form fields in the current range at the particular time when this property is first time accessed. If current range is later expanded with additional form fields, they won't be contained in this property. To obtain latest snapshot, access content range again and use its property. Read Word Form Controls in C# and VB.NET Deletes the document content specified with the current . For more information, see Delete Content example. Delete Content example Sets the content of the current to a content specified with the parameter. The which specifies content which should be set to the current . A instance which contains set content. For more information, see Set Content example. Set Content example Loads the specified to the current . The text which should be loaded to the current . A instance which contains loaded text. A load operation replaces the current 's content with the newly loaded content. For more information, see Set Content example. Set Content example Loads the specified with specific formatting to the current . The text which should be loaded to the current . The formatting of the text which should be be loaded to the current . A instance which contains loaded text. A load operation replaces the current 's content with the newly loaded content. For more information, see Set Content example. Set Content example Loads the specified to the current . The text which should be loaded to the current . The options used to define settings for load operation. A instance which contains loaded text. A load operation replaces the current 's content with the newly loaded content. For more information, see Set Content example. Set Content example Loads the specified HTML text to the current . The HTML text which should be loaded to the current . The options used to define settings for load operation. A instance which contains loaded HTML text. A load operation replaces the current 's content with the newly loaded content. For more information, see Word Editor in ASP.NET and Set Content example. Word Editor in ASP.NET Set Content example Loads the specified RTF text to the current . The RTF text which should be loaded to the current . The options used to define settings for load operation. A instance which contains loaded RTF text. Loads the specified Markdown text to the current . The Markdown text which should be loaded to the current . The options used to define settings for load operation. A instance which contains loaded Markdown text. Finds all s which contain the specified text. The text which should be searched for. All s which contain the specified text. Argument text can't be null or empty. For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Finds all s which match the specified . The which should be matched. All s which match the specified . For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Replaces all occurrences of the specified text with another text in the current . The text which should be searched for. The text which should replace all occurrences of searched text. For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Replaces all occurrences of the specified text with another text in the current . The text which should be searched for. The text which should replace all occurrences of searched text. The formatting of the replacement text. For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Replaces all matches of the specified with specified text in the current . The Regex which should be matched. The text which should replace all matches of searched . For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Replaces all matches of the specified with specified text in the current . The Regex which should be matched. The text which should replace all matches of searched . The formatting of the replacement text. For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Replaces all s which match the specified with returned by a delegate. The Regex which should be matched. Custom method that examines each matched and returns replacement . For more information, see Find and Replace example. Find and Replace text in Word file with C# and VB.NET Saves the current to the clipboard using specified text formats. List of type derivations mapping clipboard text formats. type derivation supplied inside is not supported for this operation. Use one of the supported derivations: , and Applications which save data to clipboard should try to save it in all formats supporting that specific data. Following type derivations can be used: , and . If no is specified, is saved using all supported type derivations. Thread must be set to single thread apartment (STA) mode before calls to this method can be made. Saves the current to the clipboard using specified text formats. List of type derivations mapping clipboard text formats. type derivation supplied inside is not supported for this operation. Use one of the supported derivations: , and Applications which save data to clipboard should try to save it in all formats supporting that specific data. Following type derivations can be used: , and . Thread must be set to single thread apartment (STA) mode before calls to this method can be made. Returns a plain text that represents this instance. A plain text that represents this instance. For more information, see Get Content example. Get Content example Returns a plain text that represents this instance. Options that customize the text writing. A plain text that represents this instance. For more information, see Get Content example. Get Content example Gets the child elements. Sequence of child elements. Method returns range child elements. Note that resulting enumeration will include range starting and ending element if not filtered. Iterating example Gets the child elements filtered by . The s to filter by. Sequence of child elements filtered by . Method returns range child elements filtered by . Note that resulting enumeration will include range starting and ending element if not filtered. Iterating example Counts the number of words in this content range. The number of words in this content range. This method is obsolete. Use ContentRange.LoadText(string) method instead. Sets the content of the current to a specified . The text which should be set to the current . A instance which contains set text. For more information, see Set Content example. Set Content example This method is obsolete. Use ContentRange.LoadText(string, CharacterFormat) method instead. Sets the content of the current to a specified . The text which should be set to the current . The formatting of the text which should be set to the current . A instance which contains set text. For more information, see Set Content example. Set Content example Represents a dictionary that contains key and value pairs. keys cannot be or . values cannot be and can be only one of the following types: Built-in and custom document properties are contained in class which is used in DocumentModel.DocumentProperties property. For more information, see document properties example. Gets a dictionary of linked targets from which the value of the custom document property should be extracted. The key is the name of the property, the value is the target name (e.g. bookmark name). Represents block-level Content control (Structured Document Tag). Initializes a new instance of the class. The owner document. Type of content control. Initializes a new instance of the class. The owner document. Type of content control. The content control's content. Initializes a new instance of the class. The owner document. Type of content control. The content control's content. Gets all the possible properties for this Content Control item. All the possible properties for this Content Control item. Gets the blocks of this Content Control. Blocks of this Content Control. Gets the type of this Content Control The type of this Content Control Gets the of this instance. The of this instance. Updates the content of the current with the data from . Updates the source from of the current with its content. Represents the calendar type of a Date picker Content Control item. The Gregorian calendar. This calendar should be localized into the appropriate language. The Gregorian calendar. This calendar should be presented in Arabic. The Gregorian calendar. This calendar should be presented in English. The Gregorian calendar. This calendar should be presented in Middle East French. The transliterated English version of the Gregorian calendar. The transliterated French version of the Gregorian calendar. The Hebrew calendar. The Hijri calendar. The Japanese calendar. The Korean calendar. The Saka calendar. The Taiwanese calendar. The Thai calendar. None. Represents a symbol that specifies how a CheckBox will look in a given state. Gets or sets a character used by this CheckBoxSymbol. The character used by this CheckBoxSymbol. Gets or sets a font name for this CheckBoxSymbol. The font name for this CheckBoxSymbol. Represents how Content Control is displayed in a document. Bounding Box. Start/End Tag. None. Specifies a single list item within the parent Content Control item. Initializes a new instance of the class. The text to be displayed. Initializes a new instance of the class. The text to be displayed. The value for the list item entry. Gets or sets the text which will be displayed for this list item. The text that will be displayed for this list item. Gets or sets the value of the list item. The value of the list item. Represents all possible properties for a Content Control item. Gets or sets the title of a Content Control item. The title of a Content Control item. Gets or sets the tag of a Content Control item. The tag of a Content Control item. Gets or sets the ID of a Content Control item. The ID of a Content Control item. Gets or sets a value indicating how a Content Control item should be displayed in a document. The value indicating how a Content Control item should be displayed in a document. Gets or sets the color of a Content Control item. The color of a Content Control item. Gets or sets the character format for the text inside a Content Control item. The character format for the text inside a Content Control item. Gets or sets a value indicating whether a Content Control item should be removed after it is edited. The value indicating whether a Content Control item should be removed after it is edited. Gets or sets a value indicating whether the content of a Content Control item can be edited. The value indicating whether the content of a Content Control item can be edited. Gets or sets a value indicating whether a Content Control item can be deleted. The value indicating whether a Content Control item can be deleted. Specifies the mapping between a content control and a custom XML part or a document property. The mapping between a content control and a custom XML part or a document property. Null if there is no mapping. Gets or sets a value indicating whether this Content Control item can contain multiple lines of text. This property is applicable when the parent Content Control type is . The value indicating whether this Content Control item can contain multiple lines of text. Gets or sets a value that specifies the gallery of document parts that will be used as the filter when determining the possible choices of document parts that are displayed for insertion into the Content Control item. This property is applicable when the parent Content Control type is or . The value that specifies the gallery of document parts that shall be used as the filter. Gets or sets a value that specifies the category of document parts that will be used as the filter when determining the possible choices of document parts that are displayed for insertion into the Content Control item. A document part category is a sub-classification within a given document part which can be used to further categorize the parts in a given . This property is applicable when the parent Content Control type is or . The value that specifies the category of document parts that shall be used as the filter. Gets or sets a value that specifies that the Content Control item is being used to encapsulate a built-in document part. This property is applicable when the parent Content Control type is or . The value that specifies that the Content Control item is being used to encapsulate a built-in document part. Gets or sets whether a Content Control item is checked. This property is applicable when the parent Content Control type is . The value indicating whether a Content Control item is checked. Gets a symbol that will be used if a CheckBox is checked. This property is applicable when the parent Content Control type is . The symbol that will be used if a CheckBox is checked. Gets a symbol that will be used if a CheckBox is unchecked. This property is applicable when the parent Content Control type is . The symbol that will be used if a CheckBox is unchecked. Gets list items associated with the Content Control item. This property is applicable when the parent Content Control type is or . The list items associated with the Content Control item. Gets or sets the selected value of the Content Control item. This property is applicable when the parent Content Control type is or . The selected value of the Content Control item. Gets or sets the date value of the Content Control item. This property is applicable when the parent Content Control type is . The date value of the Content Control item. Gets or sets a value that specifies the display format for a date. This property is applicable when the parent Content Control type is . The value that specifies the display format for a date. Gets or sets culture info that will be used to format a date. This property is applicable when the parent Content Control type is . The culture info that will be used to format a date. Gets or sets a value that specifies the calendar type for a Date picker Content Control. This property is applicable when the parent Content Control type is . The value that specifies the calendar type for a Date picker content control. Gets or sets a value that specifies the date storage format. This property is applicable when the parent Content Control type is . The value that specifies the date storage format. Gets or sets a value indicating whether a user is allowed to add or delete a section. This property is applicable when the parent Content Control type is . The value indicating whether a user is allowed to add or delete a section. Gets or sets a section title. This property is applicable when the parent Content Control type is . The section title. Gets or sets whether the content of the Content Control should be interpreted to contain placeholder text. True if the content of the Content Control should be interpreted to contain placeholder text; false otherwise. Gets or sets a placeholder text which should be displayed when Content Control is empty. The placeholder text which should be displayed when Content Control is empty. Represents the type of a Content Control item (Structured Document Tag). Rich Text Content Control. Plain Text Content Control. Picture Content Control. Building Block Gallery Content Control. Check Box Content Control. Combo Box Content Control. Drop-Down List Content Control. Date Picker Content Control. Repeating Section Content Control. Repeating Section Item Content Control. Equation Content Control. Citation Content Control. Bibliography Content Control. DocPartObj Content Control. Grouped Content Controls. Specifies how the date for a date Content Control item is stored. The date storage format. The date and time storage format. The text storage format. Represents Content Control and groups Content Control properties that are common for all Content Control types. Gets all the possible properties for this Content Control item. All the possible properties for this Content Control item. Gets the type of this Content Control. The type of this Content Control. Gets the owner document. The owner document. Gets the content of the current . The content of the current . For more information, see Get Content example. Get Content example Gets the of this instance. The of this instance. Gets the that contains this instance. The that contains this instance. Gets the parent of this instance. The parent of this instance. Updates the content of the current with the data from . Updates the source from of the current with its content. Represents inline-level Content Control (Structured Document Tag). Initializes a new instance of the class. The owner document. Type of content control. Initializes a new instance of the class. The owner document. Type of content control. The content control's content. Initializes a new instance of the class. The owner document. Type of content control. The content control's content. Gets all the possible properties for this Content Control item. All the possible properties for this Content Control item. Gets the inlines of this Content Control. Inlines of this Content Control. Gets the type of this Content Control The type of this Content Control Gets the of this instance. The of this instance. Updates the content of the current with the data from . Updates the source from of the current with its content. Specifies the mapping between a content control and a custom XML part or a document property. Initializes a new instance of the class. The owner document. Gets or sets a value that specifies the set of prefix mappings that will be used to interpret the XPath expression. The value that specifies the set of prefix mappings that will be used to interpret the XPath expression. Gets or sets the XPath expression that will be evaluated to find the custom XML node mapped to the content control. The XPath expression that will be evaluated to find the custom XML node mapped to the content control. Gets or sets the custom XML part that will be used to evaluate the given XPath expression. The custom XML part that will be used to evaluate the given XPath expression. Gets the built-in document property that is mapped to the content control. The built-in document property that is mapped to the content control. Null if the content control is not mapped with any built-in document property. Represents a custom XML part within a document that contains arbitrary custom XML markup. Gets the set of associated XML schemas. The set of associated XML schemas. Initializes a new instance of the class. Gets or sets the custom XML part ID. If value is not , then it should be a value converted to with a method with a B specifier. The custom XML part ID. Gets or sets the custom XML part data. The custom XML part data. Value is . Represents a collection of s. Gets the with the specified ID or . The with the specified ID or . The ID of the . The with the specified ID or . Provides a base class for generic dictionary. The type of the key. The type of the value. This class is used as a base class for , and classes. Gets the number of key/value pairs contained in the . The number of key/value pairs contained in the . Gets a collection containing the keys in the . A collection containing the keys in the . Gets a collection containing the values in the . A collection containing the values in the . Gets or sets the value associated with the specified key. The value associated with the specified key. The key of the value to get or set. The value associated with the specified key. Adds the specified key and value to the . The key of the element to add. The value of the element to add. Determines whether the contains the specified key. The key to locate in the . true if the contains an element with the specified key; otherwise, false. Removes the value with the specified key from the . The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found in the . Gets the value associated with the specified key. The key of the value to get. When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized. true if the contains an element with the specified key; otherwise, false. Removes all keys and values from the . Returns an enumerator that iterates through the . An enumerator that can be used to iterate through the . Represents a class that stores details for signing a document with a digital signature. Gets or sets the X.509 certificate. Value must be of type System.Security.Cryptography.X509Certificates.X509Certificate2. The X.509 certificate. System.Security.Cryptography.X509Certificates.X509Certificate2 Gets or sets the byte array that contains data from an X.509 certificate. The byte array that contains data from an X.509 certificate. Gets or sets the file path to the X.509 certificate. The file path to the X.509 certificate. Gets or sets a value indicating whether private keys are stored in the local computer store rather than the current user store. if private keys are stored in the local computer store rather than the current user store; otherwise, . Gets or sets the password required to access the X.509 certificate data. The password required to access the X.509 certificate data. Gets or sets the reason for the signing. The reason for the signing, such as ( I agree … ). Gets or sets the signature line. The signature line. Used to associate digital signature with document's content (so that digital signature has a placeholder for its visual representation) if digital signature is not contained in the document. If value is and is not contained in the document, then digital signature won't have any visual representation. Gets or sets the signature. The signature. If value is , then digital signature won't have any visual representation. Signature is not drawn in the same layer as the rest of the page, but in a layer above the page. If signature is contained in the document, then its position is specified through . Otherwise, if signature is not contained in the document, its position is relative to . So, if signature is not contained in the document and its layout is , then signature will have the same bottom-left position as the (they will both be in the same line). If signature is not contained in the document and its layout is , then signature will be positioned relative to regardless whether horizontal/vertical anchor is , , , or . Represents a class that stores loading options for Microsoft Word 97-2003 (DOC) format. Open and read Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Initializes a new instance of the class. Represents a document. is a central class in GemBox.Document component. It is an in-memory representation of a document file. Document content can be retrieved through DocumentModel.Sections property. For more information, see content model. To load / read a document from a file or a stream, use static DocumentModel.Load methods. To preserve unsupported file format features, set to . For more information, see preservation. To save / write a document to a file or a stream use DocumentModel.Save methods. For more information, see supported file formats. contains also following members: DocumentModel.DefaultParagraphFormat and DocumentModel.DefaultCharacterFormat - represent formatting properties for paragraphs and text that do not have any direct, inherited or style-based formatting. DocumentModel.Styles - a collection of all s in the document. For more information, see formats and styles. DocumentModel.Bookmarks - a collection of all s in the document. DocumentModel.MailMerge - used for importing .NET objects into the document. For more information, see mail merge. DocumentModel.DocumentProperties - a dictionaries of built-in and custom document properties. DocumentModel.ViewOptions - defines document view and zoom when document is viewed in an application such as Microsoft Word. See view options example. DocumentModel.WriteProtection - defines document write protection with which the document's contents can be edited but the document cannot be resaved using the same file name. See DOCX Write Protection example. GemBox.Document Content Model Open and read Word file in C# and VB.NET Create and write to Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert HTML pages to PDF in C# and VB.NET Convert Word files to image formats in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Print Word files in C# and VB.NET Initializes a new instance of the class. Open and read Word file in C# and VB.NET Create and write to Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Print Word files in C# and VB.NET Gets the collection of hyphenation dictionaries. The collection of hyphenation dictionaries. Gets the document sections. The document sections. Since class is , only supported element in this collection is . GemBox.Document Content Model Gets the document bookmarks. The document bookmarks. Gets the document comments. The document comments. Gets the document styles. The document styles. GemBox.Document Formats and Styles Gets the document properties. The document properties. Document Properties example Gets or sets the document view options. The document view options. Gets or sets the document hyphenation options. The document hyphenation options. Gets or sets the document revision options. The document revision options. Gets or sets the document write protection options. Supported only in DOCX and DOC formats. The document write protection options. Write protection refers to a mode in which the document's contents can be edited but the document cannot be resaved using the same file name. For more information, see DOCX Write Protection example. DOCX Write Protection example Gets or sets the document protection settings used to restrict editing and formatting of document content. Supported in DOCX and DOC formats. The document protection settings used to restrict editing and formatting of document content. Restrict Editing example Gets or sets the document settings. The document settings. Gets or sets the default character format. The default character format. GemBox.Document Formats and Styles Gets or sets the default paragraph format. The default paragraph format. GemBox.Document Formats and Styles Gets the object that exposes mail merge operations and options for a document. The object that exposes mail merge operations and options for a document. GemBox.Document Mail Merge Gets the custom XML parts contained in this document. The custom XML parts contained in this document. Gets a dictionary of document variables. A dictionary of document variables. Contains all revisions in the document. All revisions in the document. Contains fonts which will be embedded into the document. Note that this property is currently supported only when the is loaded from PDF and saved to DOCX file format. Represents the contained in the . If the does not have contained, it will be created on accessing this property. Loads a document from the specified stream. This method tries to dynamically determine the file format. If you know the file format, it is more reliable and faster to use method. The stream from which to load a document. A loaded document. Open and read Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Loads a document from the specified stream. The stream from which to load a document. The loading options which can be used to define settings for load operation. A loaded document. Open and read Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Loads a document from a file with the specified path. The path from which to load a document. A loaded document. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension is not supported on the current platform. File extension that is extracted from the is used to create the appropriate derived class instance that is then passed to the method. Following file extensions are supported:Microsoft Word: .docx, .docm, .dotm, .dotxMicrosoft Word 97-2003: .doc, .dotOpenDocument Text: .odtPortable Document Format: .pdfHyperText Markup Language: .htm, .html, .mht, .mhtmlExtensible Markup Language (Flat OPC and WordML): .xmlRich Text Format: .rtfPlain Text: .txt Open and read Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Loads a document from a file with the specified path. The path from which to load a document. The loading options which can be used to define settings for load operation. A loaded document. Open and read Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Saves the document in the specified stream. The stream in which to save the document. The saving options which can be used to define settings for save operation. Create and write to Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Saves the document to a file with the specified path. The path to which to save the document. The saving options which can be used to define settings for save operation. Create and write to Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Saves the document to a file with the specified path. Path must include file extension. The path to which to save the document. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension is not supported on the current platform. File extension that is extracted from the is used to create the appropriate derived class instance that is then passed to the method. Following file extensions are supported:Microsoft Word: .docx, .docm, .dotm, .dotxOpenDocument Text: .odtPortable Document Format: .pdfXML Paper Specification: .xpsImage: .bmp, .gif, .jpg, .jpeg, .png, .tif, .tiff, .wdpHyperText Markup Language: .htm, .html, .mht, .mhtmlExtensible Markup Language (Flat OPC): .xmlRich Text Format: .rtfPlain Text: .txt Create and write to Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Save the document to HTML format using the specified writer. The writer which is used to save the document. The HTML saving options which can be used to define settings for save operation. Convert Word files to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Saves the document to a System.Web.HttpResponse or System.Web.HttpResponseBase output stream or a System.Net.Http.HttpResponseMessage and sets appropriate HTTP response headers (Content-Type and Content-Disposition). Use this method in ASP.NET application to send the document to a client browser. File format is resolved from extension. See remarks why parameter is of type . System.Web.HttpResponse object that can be retrieved through the Response property of the System.Web.HttpApplication, System.Web.HttpContext, System.Web.UI.Page or System.Web.UI.UserControl classes or System.Web.HttpResponseBase object or System.Net.Http.HttpResponseMessage object. File name that will be presented in client browser when downloading a file. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. Supported only if updating the whole page with a postback and not if doing partial-page updates (when you use UpdatePanel controls to update selected regions of a page). This method accepts rather than HttpResponse, HttpResponseBase or HttpResponseMessage because otherwise GemBox.Document assembly would have a dependency on System.Web or System.Net.Http assemblies and could not be used in applications which target Client Profile .NET Framework. HttpResponse can be retrieved through the Response property of the HttpApplication, HttpContext, Page or UserControl classes. For supported file extensions, see remarks for method. Export Word in ASP.NET Word Editor in ASP.NET Saves the document to a System.Web.HttpResponse or System.Web.HttpResponseBase output stream or a System.Net.Http.HttpResponseMessage and sets appropriate HTTP response headers (Content-Type and Content-Disposition). Use this method in ASP.NET application to send the document to a client browser. File format is defined with parameter. See remarks why parameter is of type . System.Web.HttpResponse object that can be retrieved through the Response property of the System.Web.HttpApplication, System.Web.HttpContext, System.Web.UI.Page or System.Web.UI.UserControl classes or System.Web.HttpResponseBase object or System.Net.Http.HttpResponseMessage object. File name that will be presented in client browser when downloading a file. The saving options which can be used to define settings for save operation. Supported only if updating the whole page with a postback and not if doing partial-page updates (when you use UpdatePanel controls to update selected regions of a page). This method accepts rather than HttpResponse, HttpResponseBase or HttpResponseMessage because otherwise GemBox.Document assembly would have a dependency on System.Web or System.Net.Http assemblies and could not be used in applications which target Client Profile .NET Framework. HttpResponse can be retrieved through the Response property of the HttpApplication, HttpContext, Page or UserControl classes. Export Word in ASP.NET Word Editor in ASP.NET Converts this instance to an instance. The options used when converting to XML Paper Specification (XPS) document. A new instance created from this instance. Export Word to XpsDocument in WPF Converts single page specified in of this instance to an instance. The options used when converting a single document's page to an image. A new instance created from a single document's page specified in . Export Word to ImageSource in WPF Prints the document to the default printer. Print Word files in C# and VB.NET Prints the document to the specified printer. Printer name. Print Word files in C# and VB.NET Prints the document to the specified printer according to specified options. Printer name. Print options. Print Word files in C# and VB.NET Gets the document paginator. The document paginator. Gets the document paginator and updates the document based on the specified . The paginator options used to specify which parts of the document to update while paginating it. The document paginator. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Imports (clones) the specified source element to this instance so it can be inserted into document content. The type to import. The source element. to import source element descendants; otherwise . Imported (cloned) source element that can be inserted in this instance. GemBox.Document Content Model Importing example Imports (clones) the specified source element to this instance so it can be inserted into document content. The type to import. The source element. to import source element descendants; otherwise . to use destination document (this instance) styles; otherwise to use source document styles. Imported (cloned) source element that can be inserted in this instance. GemBox.Document Content Model Importing example Imports (clones) the specified source element to this instance so it can be inserted into document content. The type to import. The source element. to import source element descendants; otherwise . Mapping used to match source and destination document styles and other referenced objects. Imported (cloned) source element that can be inserted in this instance. GemBox.Document Content Model Join or Combine Word files in C# and VB.NET Calculates the list items contained in this document. A sequence of s contained in this document. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets a file name of the document. The document's file name if it was loaded from path; otherwise, . Represents a document page. Gets the page width in s. The page width in s. Gets the page height in s. The page height in s. Gets the content of the page. The content of the page. Gets the range in the that corresponds to this page. Obtains position and size of the element on the page. Element for which to obtain the position and size. The position and size of the element. , if the element is not supported or it is not present on the page. Currently supported elements are , , , and . Extracts a from this page. The extracted document model. Saves the document page in the specified stream. The stream in which to save the document page. The saving options which can be used to define settings for save operation. Saves the document page to a file with the specified path. The path to which to save the document page. The saving options which can be used to define settings for save operation. Saves the document page to a file with the specified path. Path must include file extension. The path to which to save the document page. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension that is extracted from the is used to create the appropriate derived class instance that is then passed to the method. Provides a functionality to paginate the document content. Gets the document pages. The document pages. Gets a segment of pages of the source paginated document. The zero-based index of the first page in the segment. The number of pages in the segment. A that represents a segment of pages of the source paginated document. This method doesn't repaginate the document, it only returns the subrange of already paginated pages. Saves the paginated document to the specified stream. The stream in which to save the paginated document. The saving options which can be used to define settings for save operation. Saves the paginated document to a file with the specified path. The path to which to save the paginated document. The saving options which can be used to define settings for save operation. Saves the paginated document to a file with the specified path. Path must include file extension. The path to which to save the paginated document. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension that is extracted from the is used to create the appropriate derived class instance that is then passed to the method. Extracts a from this paginator. The extracted document model. Converts this instance to an instance. The options used when converting to XML Paper Specification (XPS) document. A new instance created from this instance. Export Word to XpsDocument in WPF Converts single page specified in of this instance to an instance. The options used when converting a single document's page to an image. A new instance created from a single document's page specified in . Export Word to ImageSource in WPF Prints the paginated document to the default printer. Print Word files in C# and VB.NET Prints the paginated document to the specified printer. Printer name. Print Word files in C# and VB.NET Prints the paginated document to the specified printer according to specified options. Printer name. Print options. Print Word files in C# and VB.NET Contains a dictionaries of built-in and custom document properties. For supported key-value pairs in each dictionary, see and . For more information, see document properties example. Gets a dictionary of built-in document properties. A dictionary of built-in document properties. Gets a dictionary of custom document properties. A dictionary of custom document properties. Represents a set of document protection restrictions which have been applied to the contents of a document. Document protection is a set of restrictions used to prevent unintentional changes to all or part of a document - since this protection does not encrypt the document, malicious applications may circumvent its use. This protection is not intended as a security feature and may be ignored. Restrict Editing example Gets or sets a value indicating whether formatting is limited just to unlocked styles. if formatting is limited just to unlocked styles; otherwise, . Gets or sets a value indicating whether document protection settings shall be enforced for a given document. if document protection settings shall be enforced; otherwise, . Gets or sets the set of editing restrictions which shall be enforced on a given document. The set of editing restrictions which shall be enforced on a given document. Gets a value indicating whether document protection has password. if document protection has password; otherwise, . Sets the password. If password is or empty, any existing password will be cleared. The password. Starts enforcing protection by restricting document editing actions to those specified by parameter with optional password which must be specified to stop protection in consumer application such as MS Word. The editing restriction enforced upon the document in consumer application such as MS Word. The optional password which must be specified to stop protection in consumer application such as MS Word. Restrict Editing example Stops enforcing protection and clears password, if there is any. Restrict Editing example Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents stored preferences which shall be used when processing the contents of the document. Gets or sets a value indicating whether changes are tracked as revisions. if changes are tracked when this document is edited in Microsoft Word; otherwise, . GemBox.Document does not use this option when updating the document, it does not automatically track changes. This option only instructs Microsoft Word whether the track changes are enabled or disabled. Gets or sets the location of a document template which shall be attached to the current document if it is accessible and of a format supported by an application such as MS Word. The location of a document template which shall be attached to the current document. If value is or , then the document shall not have an attached document template, and applications should use their default template in its place. Gets or sets a value indicating whether the styles in the specified document are updated to match the styles in the attached template each time the document is opened by an application such as MS Word. if the styles in the specified document are updated to match the styles in the attached template each time the document is opened; otherwise, . GemBox.Document does not use this flag to update styles when document is loaded. Gets the footnote settings. The footnote settings. can be configured using on a document level ( and ) or on a section level ( and . Document level settings are cloned when new is added to the . PDF format has the following limitations: Footnotes are always rendered on the same page as their references. Footnotes that don't fit on a single page are clipped. Note numbering setting is not supported. HTML and TXT formats have the following limitations: All footnotes and then endnotes are exported at the end of the document. Note numbering setting is not supported. Gets the endnote settings. The endnote settings. can be configured using on a document level ( and ) or on a section level ( and . Document level settings are cloned when new is added to the . PDF format has the following limitations: Footnotes are always rendered on the same page as their references. Footnotes that don't fit on a single page are clipped. Note numbering setting is not supported. HTML and TXT formats have the following limitations: All footnotes and then endnotes are exported at the end of the document. Note numbering setting is not supported. Gets or sets a value indicating whether the left and right margins defined in the shall be swapped on facing pages. if the left and right margins defined in the shall be swapped on facing pages; otherwise, . This setting is generally used when printing on both sides of pages and binding them like a book. Gets or sets a value indicating whether to print the document as a book fold. Supported only in DOCX format. to print a document in a series of booklets so the printed pages can be folded and read as a book; otherwise, . Gets or sets a value indicating whether to print the document as a reverse book fold. Supported only in DOCX format. to reverse the printing order for book fold printing of bidirectional or Asian language documents; otherwise, . Gets or sets the number of pages to be included in each booklet. The number of pages for each booklet. Gets or sets a value indicating whether to print two pages per sheet. Supported only in DOCX format. to print a document two pages per sheet; otherwise, . Initializes a new instance of the class. Gets or sets the value which shall be used as the multiplier to generate automatic tab stops in this document. Default value is 36 points (half an inch). The value which shall be used as the multiplier to generate automatic tab stops in this document. Automatic tab stops refer to the tab stop locations which occur after all custom tab stops in the current paragraph have been surpassed. Gets or sets a value indicating whether to justify the contents of incomplete lines which end in a soft line break when the parent paragraph is justified. to not expand character spaces on the line ending in justified paragraph; otherwise, . Gets or sets the Microsoft Word compatibility mode. For Microsoft Word 2016, set this value to 15. The Microsoft Word compatibility mode. Gets or sets the string to use as the decimal separator in numeric values in the document. The string to use as the decimal separator in numeric values in the document. Clones this instance. Cloned . Clones this instance. Destination document which will store styles etc. from cloned elements. Cloned . Gets or sets a value indicating whether the left and right margins defined in the shall be swapped on facing pages. if the left and right margins defined in the shall be swapped on facing pages; otherwise, . This setting is generally used when printing on both sides of pages and binding them like a book. Represents a class that stores details for signing a document saved to DOCX file with a digital signature. Document will be digitally signed when saved to a DOCX if , or is specified, otherwise it will be saved but not digitally signed. Gets or sets a value indicating whether the signature is XMS Advanced Electronic Signature (XAdES). The default value of this property is . if the signature is XML Advanced Electronic Signature (XAdES); otherwise, . Gets or sets the commitment type when signing a document. The commitment type when signing a document. This property is saved to the document only when is . Gets or sets the signer role. The signer role. This property is saved to the document only when is . Get or sets the location at which the signature was created The location at which the signature was created This property is displayed in document only when is . Get or sets the additional location at which the signature was created The additional location at which the signature was created This property is displayed in document only when is . Gets or sets the city associated with the signer The city associated with the signer This property is saved to the document only when is . Gets or sets the state or province associated with the signer The state or province associated with the signer This property is saved to the document only when is . Gets or sets the postal or zip code associated with the signer The postal or zip code associated with the signer This property is saved to the document only when is . Gets or sets the country associated with the signer The country associated with the signer This property is saved to the document only when is . Gets additional certificates to be embedded in the signature. The additional certificates to be embedded in the signature. This property is saved to the document only when is . Initializes a new instance of the class. An enumeration of Microsoft Word file formats. Word Document. Word Macro-Enabled Document. Word Template. Word Macro-Enabled Template. Represents a class that stores loading options for Microsoft Word (DOCX) format. Open and read Word file in C# and VB.NET Convert Word files to PDF in C# and VB.NET Convert Word files to image formats in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets or sets the password to open protected / encrypted document. The password to open protected / encrypted document. DOCX Encryption in C# and VB.NET Occurs when the loading progress of a document has changed. The file path or stream that was provided as a document source is used as a . Determines whether the file is an encrypted DOCX. The path from which to read a file. if file is an encrypted DOCX; otherwise, . Determines whether the file is an encrypted DOCX. The stream from which to read a file. if file is an encrypted DOCX; otherwise, . Initializes a new instance of the class. Represents a class that stores saving options for Microsoft Word file. To save a document as a macro-enabled document, template document or macro-enabled template document, set property to appropriate value. Create and write to Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets or sets the Word file format into which to save the instance. The Word file format into which to save the instance. Gets or sets the password used to protect / encrypt the document. The password used to protect / encrypt the document. DOCX Encryption in C# and VB.NET Gets or sets the saved images DPI. The saved images DPI. This property controls the image quality for all images in the file. Larger value results in better-quality images but increases the file size. Setting this property to 0 will disable image optimization. Standard DPI values are: 330 - Good quality for HD displays 220 - Good quality for most printers and displays 150 - Good quality for web pages and projectors 96 - Good quality for smaller file sizes Using this property you basically specify the DPI of the display device on which the file will be viewed and for which the images in the file should be optimized without losing any perceived quality because images go through the same resampling (reduction of pixel count) as they would in the viewer application if viewing the file using the default (100%) zoom factor on that display device. For example, if an image whose pixel size is 600px × 400px is shown on page where it occupies a slot whose physical size is 150pt × 100pt, then if the display device DPI is 144px/inch, the viewer application will show the image in a display slot whose pixel size is 300px × 200px if the default (100%) zoom factor is used (Rationale: there are always 72 points per inch and for the DPI of 144, there are 144 pixels per inch, so 150[pt] = 150[pt] × 144[px/inch] / 72[pt/inch] = 300[px]).
So the viewer application has to fit an image into a smaller display slot and it will do so by resampling the image from 600px × 400px to 300px × 200px.
Reducing the total number of pixels 4 times (from 240000 to 60000) would also reduce the image file size, so GemBox component can do this instead of the viewer application, thus achieving the overall smaller file size without any perceived loss of quality since the same image resampling would have been done by the viewer application anyway if the default (100%) zoom factor is used.
Instructing the GemBox component to perform image resampling (by setting the property to the DPI of the display device on which the file is going to be viewed) has two effects: Major benefit: output file size will be smaller if there are images whose pixel size is greater than their display size because those images are resampled to a smaller number of pixels without any perceived loss of quality since the same resampling would have been done by the viewer application anyway. Minor benefit: viewer application will be able to present the image faster because it needs to decode a fewer number of pixels and because the display slot size will be exactly equal to the image pixel size so it doesn't have to perform any resampling if the default (100%) zoom factor is used. Occurs when the saving progress of a document has changed. The file path or stream that was provided as a document destination is used as a . Gets the digital signature options. The digital signature options. Initializes a new instance of the class. Gets the content-type for DOCX file format: application/vnd.openxmlformats. The content-type for DOCX file format. Represents a type which describes how the area is painted or filled. Different brushes have different types of output. Some brushes paint an area with a solid color, others with a gradient, pattern or image. GemBox.Document currently supports only . All other brush types are supported only through preservation. Shapes and layout article Shapes example Gets a value indicating whether the parent element is filled. if the parent element is not filled; otherwise, . Shapes and layout article Shapes example Sets a solid color fill on the parent element. The color to apply to the fill. A brush which specifies a solid color fill which will be applied to the parent element. Shapes and layout article Shapes example Sets a solid color fill on the parent element. The color to apply to the fill. The color opacity (0 = fully transparent, 255 = fully opaque). A brush which specifies a solid color fill which will be applied to the parent element. Shapes and layout article Shapes example Sets a pattern fill on the parent element. The type of the pattern. The foreground color to apply to fill. The backgroundColor color to apply to fill. A brush which specifies a pattern fill which will be applied to the parent element. Shapes and layout article Shapes example Sets a gradient fill on the parent element. The gradient fill type to apply to the fill. A brush which specifies a gradient fill which will be applied to the parent element. Shapes and layout article Shapes example Sets the fill to the picture fill. This method is not applicable on property. Path or link to a picture data. if the picture is linked to the file in which instance is saved; otherwise, . An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. is or or doesn't contain extension or extension is not supported. Use this overload to automatically detect the picture content type from the extension. Parameter must contain supported extension (for example, ".png") if is , otherwise exception is thrown. Sets the fill to the picture fill. This method is not applicable on property. Path to a picture data. Content type of the picture data. An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. is or . Use this overload to explicitly specify picture content type (for example, if doesn't specify a file extension). Sets the fill to the picture fill. This method is not applicable on property. Path to a picture data. Content type (MIME type) of the picture data. An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. or is or . Use this overload to explicitly specify picture content type that is not supported by the . Sets the fill to the picture fill. This method is not applicable on property. Stream containing the picture data. An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. is . Picture encoding format is not supported. Use this overload to automatically detect the picture content type from the decoded picture . Sets the fill to the picture fill. This method is not applicable on property. Stream containing the picture data. Content type of the picture data. An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. is . Use this overload to explicitly specify picture content type so that the picture doesn't have to be decoded to detect the picture content type. Sets the fill to the picture fill. This method is not applicable on property. Stream containing the picture data. Content type (MIME type) of the picture data. An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. is . is or . Use this overload to explicitly specify picture content type that is not supported by the . Sets the fill to the picture fill. This method is not applicable on property. Content of the picture data. An instance of a type that was set and can be used to set tiling or stretch options of the picture fill. is . Use this overload if multiple s should share the same picture data. Sets an empty fill on the parent element (element won't be filled). A brush which specifies that no fill will be applied to the parent element. Shapes and layout article Shapes example Sets a default fill on the parent element (element will be filled based on the default settings). A brush which specifies that default fill will be applied to the parent element. Shapes and layout article Shapes example Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents a which serves as a container for elements which are outside page main content flow. is a content consisting of derived elements (s and s). 's shape type (geometry) is represented by enumeration. It can be retrieved from property. can be filled with a and outlined with a . can be positioned in-line with the rest of the document content or floating within document content. For more information, see remarks for DrawingElement.Layout property. GemBox.Document Content Model GemBox.Document Shapes and Layout Initializes a new instance of empty with specified layout (position and size). The owner document. The canvas layout (position and size). is . Initializes a new instance of the class. The owner document. The canvas shape's layout (position and size). The canvas shape content. , , or is . Initializes a new instance of the class. The owner document. The canvas shape's layout (position and size). The canvas shape content. is . Gets the element type for which is . The value. Gets all the drawings contained in this canvas. All the drawings contained in this canvas. Adds a drawing to this canvas. The drawing which will be added to this canvas. Removes a drawing from this canvas. The drawing which will be removed from this canvas. Removing drawing will not change the position of the canvas. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a base class for all drawings (shapes, text-boxes, pictures, etc.). can contain metadata (non-visual properties) which is available through DrawingElement.Metadata property. can be positioned in-line with the rest of the document content or floating within document content. For more information, see remarks for DrawingElement.Layout property. GemBox.Document Content Model GemBox.Document Shapes and Layout Gets or sets the layout (position and size). The layout (position and size). Value is . Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Gets or sets the character format. The character format. This property is defined as direct formatting, since it is directly applied to the and supersedes any formatting from styles. For more information about character formatting, see character formatting example. Gets or sets a value indicating whether this is hidden. Default value is . if is hidden; otherwise, . Gets the metadata (non-visual properties) of this instance. The metadata (non-visual properties) of this instance. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Formats this to its default size so it can be exported to PDF, XPS, image or be printed. that can be exported to PDF, XPS, image or be printed. Drawing cannot be formatted because it doesn't belong to any document. Formats this to its default size so it can be exported to PDF, XPS, image or be printed. The options used to specify which parts of the drawing element to update while formatting it. that can be exported to PDF, XPS, image or be printed. Drawing cannot be formatted because it doesn't belong to any document. Formats this to specified size so it can be exported to PDF, XPS, image or be printed. The formatted drawing width. The formatted drawing height. The formatted drawing width / height length unit. that can be exported to PDF, XPS, image or be printed. Drawing cannot be formatted because it doesn't belong to any document. Formats this to specified size so it can be exported to PDF, XPS, image or be printed. The formatted drawing width. The formatted drawing height. The formatted drawing width / height length unit. The options used to specify which parts of the drawing element to update while formatting it. that can be exported to PDF, XPS, image or be printed. Drawing cannot be formatted because it doesn't belong to any document. Represents a set of non-visual properties which shall be applied to the parent . Gets or sets the name of this drawing. The name of this drawing. Gets or sets the alternative text for the current element, for use by assistive technologies or applications which will not display the current element. The alternative text for the current element, for use by assistive technologies or applications which will not display the current element. Gets or sets the title, caption, for the current element. The title for the current element. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents a formatted that can be exported to PDF, XPS, image or be printed. Gets the drawing width in s. The drawing width in s. Gets the drawing height in s. The drawing height in s. Gets the drawing content. The drawing content. Saves the drawing in the specified stream. The stream in which to save the drawing. The saving options which can be used to define settings for save operation. Parameter , currently, must be of type , or . Saves the drawing to a file with the specified path. The path to which to save the drawing. The saving options which can be used to define settings for save operation. Parameter , currently, must be of type , or . Saves the drawing to a file with the specified path. Path must include file extension. The path to which to save the drawing. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. File extension that is extracted from the is used to create the appropriate derived class instance that is then passed to the method. Following file extensions are supported:Portable Document Format: .pdfXML Paper Specification: .xpsPortable Network Graphics: .pngJoint Photographic Experts Group: .jpeg, .jpgBitmap: .bmpTagged Image File Format: .tiff, .tifWindows Media Photo: .wdp Saves the drawing to a System.Web.HttpResponse or System.Web.HttpResponseBase output stream or a System.Net.Http.HttpResponseMessage and sets appropriate HTTP response headers (Content-Type and Content-Disposition). Use this method in ASP.NET application to send the drawing to a client browser. File format is resolved from extension. See remarks why parameter is of type . System.Web.HttpResponse object that can be retrieved through the Response property of the System.Web.HttpApplication, System.Web.HttpContext, System.Web.UI.Page or System.Web.UI.UserControl classes or System.Web.HttpResponseBase object or System.Net.Http.HttpResponseMessage object. File name that will be presented in client browser when downloading a file. If file extension is not specified or not supported. If file extension is not recognized, use method overload instead. Supported only if updating the whole page with a postback and not if doing partial-page updates (when you use UpdatePanel controls to update selected regions of a page). This method accepts rather than HttpResponse, HttpResponseBase or HttpResponseMessage because otherwise GemBox.Document assembly would have a dependency on System.Web or System.Net.Http assemblies and could not be used in applications which target Client Profile .NET Framework. HttpResponse can be retrieved through the Response property of the HttpApplication, HttpContext, Page or UserControl classes. For supported file extensions, see remarks for method. Saves the drawing to a System.Web.HttpResponse or System.Web.HttpResponseBase output stream or a System.Net.Http.HttpResponseMessage and sets appropriate HTTP response headers (Content-Type and Content-Disposition). Use this method in ASP.NET application to send the drawing to a client browser. File format is defined with parameter. See remarks why parameter is of type . System.Web.HttpResponse object that can be retrieved through the Response property of the System.Web.HttpApplication, System.Web.HttpContext, System.Web.UI.Page or System.Web.UI.UserControl classes or System.Web.HttpResponseBase object or System.Net.Http.HttpResponseMessage object. File name that will be presented in client browser when downloading a file. The saving options which can be used to define settings for save operation. Supported only if updating the whole page with a postback and not if doing partial-page updates (when you use UpdatePanel controls to update selected regions of a page). This method accepts rather than HttpResponse, HttpResponseBase or HttpResponseMessage because otherwise GemBox.Document assembly would have a dependency on System.Web or System.Net.Http assemblies and could not be used in applications which target Client Profile .NET Framework. HttpResponse can be retrieved through the Response property of the HttpApplication, HttpContext, Page or UserControl classes. Prints the drawing to the default printer. Prints the drawing to the specified printer. Printer name. Prints the drawing to the specified printer according to specified options. Printer name. Print options. Represents a fill with a smooth gradual transition of colors at the specified locations that either follows a line or a path. Shapes Example Gets or sets the type of the fill gradient. The type of the fill gradient. Currently, only and types are supported when saving to PDF, XPS, or image formats. Gets or sets a value indicating whether the fill should rotate with the shape. if fill should rotate with the shape; otherwise, . If set to and a shape that has been filled with a gradient is transformed with a rotation, then the fill will be transformed with the same rotation. Specifies the direction of color change for the gradient. The direction of the color change for the gradient, expressed as a value between 0 and 1. This property is applicable only when is . Specifies whether the gradient angle scales with the fill region. if the gradient angle scales with the fill region, otherwise. This property is applicable only when is . Gets the collection of gradient stops in this fill format. The collection of gradient stops in this fill format Gets or sets the rectangle defining the fill area for the gradient. A that defines the fill area. This property is not applicable when is . Gets or sets the rectangle defining the tile area for repeating gradient patterns. A that defines the tile area. This property is not applicable when is . Represents a type of gradient fill. The linear fill type. The radial fill type. The rectangular fill type. The path fill type. Represents a single gradient stop in a gradient fill. Specifies where this gradient stop should appear in the color band. This position is expressed as a percentage from 0 to 1. The position of the gradient stop. Specifies the color of the gradient. The color of the gradient. Initializes a new instance of the class with the specified position and color. The position in the gradient where the gradient stop is placed. Value must be between 0 and 1. The color value of the gradient stop. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Determines whether the   is equal to this instance. The other gradient stop to compare with this gradient stop instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this gradient stop instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first gradient stop. The second gradient stop. if and gradient stops are equal; otherwise, . Determines whether and  s are not equal. The first gradient stop. The second gradient stop. if and gradient stops are not equal; otherwise, . Represents a collection of gradient stops in a gradient fill. Adds a new gradient stop. The position of the gradient stop expressed as a percentage from 0 to 1. The color of the gradient stop. A newly added gradient stop. Inserts a new gradient stop with the specified name at the specified index. The position in the collection where the new gradient stop should be inserted. The position of the gradient stop expressed as a percentage from 0 to 1. The color of the gradient stop. A newly inserted gradient stop. is less than 0 or greater than . Gets the number of s contained in the collection. The number of s contained in the collection. Gets or sets the at the specified index. The at the specified index. The zero-based index of the to get or set. The at the specified index. is less than zero or is equal to or greater than . Inserts a to the collection at the specified index. The zero-based index at which should be inserted. The to insert into the collection. is less than zero or is equal to or greater than . Adds a to the end of the collection. The to be added to the end of the collection. is . Removes the at the specified index of the collection. The zero-based index of the to remove. is less than zero or is equal to or greater than . Determines whether a is in the collection. The to locate in the collection. if is found in the collection; otherwise, . is . Searches for the specified and returns the zero-based index of the first occurrence within the entire collection. The to locate in the collection. The zero-based index of the first occurrence of within the entire collection, if found; otherwise, -1. Removes the first occurrence of a specific from the collection. The to remove from the collection. if is successfully removed; otherwise, . This method also returns if was not found in the original collection. Removes all s from the collection. Returns an enumerator that iterates through the . An for the collection. Represents a drawing that groups other drawings. Initializes a new instance of the class. The owner document. The group shape's layout (position and size). is . Initializes a new instance of the class. The owner document. The group shape's layout (position and size). The group shape content. is . Initializes a new instance of the class. The owner document. The group shape's layout (position and size). The group shape content. is . Gets the element type for which is . The value. Gets the that specifies how the group's interior drawings are filled. The that specifies how the group's interior drawings are filled. Gets all the drawings contained in this group. All the drawings contained in this group. Adds a drawing to this group. The drawing which will be added to this group. Removes a drawing from this group. The drawing which will be removed from this group. Removing drawing will not change the position of the group. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Gets or sets a value indicating whether the size of this group is custom or it should be automatically calculated based on its children. true if the size of the group should be as it is, false if the size should be automatically calculated from its children when saving. Default value is false. Specifies the properties for displaying an online video to the user. Gets or sets the embedded HTML to be rendered within the . The embedded HTML to be rendered within the . Gets or sets the width of the rendered HTML page in pixels. The width of the rendered HTML page in pixels. Gets or sets the height of the rendered HTML page in pixels. The height of the rendered HTML page in pixels. Initializes a new instance of the class. The embedded HTML to be rendered within the . The width of the rendered HTML page in pixels. The height of the rendered HTML page in pixels. Represents a brush which fills an area with a repeated pattern. This brush can use predefined patterns to fill an area. Additionally, it supports custom pattern data or patterns derived from an image file if the document file provides suitable pattern information. Shapes and layout article Shapes example Gets or sets the background color of this . The background color of this . Shapes and layout article Shapes example Gets or sets the foreground color of this . The foreground color of this . Shapes and layout article Shapes example Gets or sets the type of this . The type of this , or if custom pattern data is used. Shapes and layout article Shapes example Specifies the pattern that shall be used to lay the pattern color over the background color for shading. No filling. No pattern. Background color only. No pattern. Foreground color only. 5% of the foreground color. 10% of the foreground color. 12.5% of the foreground color. 15% of the foreground color. 20% of the foreground color. 25% of the foreground color. 30% of the foreground color. 35% of the foreground color. 37.5% of the foreground color. 40% of the foreground color. 45% of the foreground color. 50% of the foreground color. 55% of the foreground color. 60% of the foreground color. 62.5% of the foreground color. 65% of the foreground color. 70% of the foreground color. 75% of the foreground color. 80% of the foreground color. 85% of the foreground color. 87.5% of the foreground color. 90% of the foreground color. 95% of the foreground color. Dark Horizontal Dark Vertical Dark Downward Diagonal Dark Upward Diagonal Small Checker Board Trellis Light Horizontal Light Vertical Light Downward Diagonal Light Upward Diagonal Small Grid Dotted Diamond Wide Downward Diagonal Wide Upward Diagonal Dashed Upward Diagonal Dashed Downward Diagonal Narrow Vertical Narrow Horizontal Dashed Vertical Dashed Horizontal Large Confetti Large Grid Horizontal Brick Large Checker Board Small Confetti Zig Zag Solid Diamond Diagonal Brick Outlined Diamond Plaid Sphere Weave Dotted Grid Pattern Divot Shingle Wave Horizontal Vertical Cross Downward Diagonal Upward Diagonal Diagonal Cross Horizontal Cross Diagonal Stripe Reverse Diagonal Stripe Horizontal Stripe Vertical Stripe Thin Diagonal Cross Thin Diagonal Stripe Thin Reverse Diagonal Stripe Thin Horizontal Cross Thin Horizontal Stripe Thin Vertical Stripe Represents a type which describes how a shape is outlined. Shapes and layout article Shapes example Gets the fill of the outline produced by this . The fill of the outline produced by this . Shapes and layout article Shapes example Gets or sets the thickness of the stroke produced by this . The thickness of the stroke produced by this . Value cannot be negative. Shapes and layout article Shapes example Gets or sets the compound line type. The compound line type. is currently not supported when exporting a document to PDF, XPS, or image formats. Gets or sets the dash type. The dash type. Gets or sets the line join type that indicates how connected lines are joined. Default value is . The line join type that indicates how connected lines are joined. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents the compound line type. is currently not supported when exporting a document to PDF, XPS, or image formats. Single line: one normal width. Double lines of equal width. Double lines: one thick, one thin. Double lines: one thin, one thick. Three lines: thin, thick, thin. Specifies dash type for how a outlines a shape. is specified through property. A continuous solid line. A line consisting of dashes. A line with a repeating pattern of a dash followed by a dot. A line consisting of dots. A line with larger dashes than the standard dash style. A line with a repeating pattern of a large dash followed by a dot. A line with a repeating pattern of a large dash followed by two dots. A system-defined dashed line style. A system-defined line with a dash followed by a dot pattern. A system-defined line with a dash followed by two dots pattern. A system-defined dotted line style. Represents values that specify how the adjacent lines are joined. A round joint specifies that lines joined together have a round join. A bevel joint specifies that an angle joint is used to connect lines. A miter joint specifies that a line join shall be mitered. Specifies the amount of compression that has been used for a particular binary large image or picture (blip). No compression was used. Compression size suitable for inclusion with email. Compression size suitable for high quality printing. Compression size suitable for printing. Compression size suitable for viewing on screen. Represents a picture that has an associated content that is either embedded in or linked to the document file. Gets the picture content (picture data encoded in a particular format) that is either embedded in or linked to the document file. The picture content (picture data encoded in a particular format) that is either embedded in or linked to the document file. Gets the type of the compression. The type of the compression. Gets the picture content effects. The picture content effects. Gets the type of the picture content. The type of the picture content. Gets the width of the picture in pixels. The width of the picture in pixels. Gets the height of the picture in pixels. The height of the picture in pixels. Represents effects that can be applied to the picture content. Gets or sets the transparency of the picture. Possible values range from 0 (full transparency) to 1 (no transparency). The default value is 1 (no transparency). The transparency of the picture. Represents a fill with a picture that can either be tiled (as a texture) or stretched to fill the available area. This fill is not supported for outlines, borders and underlines. Gets the picture data that has an associated content that is either embedded in or linked to the document file. The picture data that has an associated content that is either embedded in or linked to the document file. Gets or sets a value indicating whether the fill should rotate with the shape. Default value: . if fill should rotate with the shape; otherwise, . If set to and a shape that has been filled with a picture is transformed with a rotation, then the fill will be transformed with the same rotation. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the left edge of the picture specified as a relative value (percentage of the picture data width, value of 1 is equal to 100% of the picture data width). The offset (inset if the value is positive or outset if the value is negative) of the left edge of the picture . To reverse the effect of extra stretching caused because cropped picture data is stretched, increment the by the . To inset the stretched picture data into the filling area you can either set the to a positive value or to a negative value depending on which size you choose to use as a basis ( uses filling area width as a basis and uses picture data width as a basis). To outset the stretched picture data outside of the filling area you can either set the to a negative value or to a positive value depending on which size you choose to use as a basis ( uses filling area width as a basis and uses picture data width as a basis). If the picture is tiled ( is ), then cropped parts of the picture data are covered by the adjacent tiles and all tiles consist of the non-cropped part of the picture data. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the right edge of the picture specified as a relative value (percentage of the picture data width, value of 1 is equal to 100% of the picture data width). The offset (inset if the value is positive or outset if the value is negative) of the right edge of the picture . To reverse the effect of extra stretching caused because cropped picture data is stretched, increment the by the . To inset the stretched picture data into the filling area you can either set the to a positive value or to a negative value depending on which size you choose to use as a basis ( uses filling area width as a basis and uses picture data width as a basis). To outset the stretched picture data outside of the filling area you can either set the to a negative value or to a positive value depending on which size you choose to use as a basis ( uses filling area width as a basis and uses picture data width as a basis). If the picture is tiled ( is ), then cropped parts of the picture data are covered by the adjacent tiles and all tiles consist of the non-cropped part of the picture data. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the top edge of the picture specified as a relative value (percentage of the picture data height, value of 1 is equal to 100% of the picture data height). The offset (inset if the value is positive or outset if the value is negative) of the top edge of the picture . To reverse the effect of extra stretching caused because cropped picture data is stretched, increment the by the . To inset the stretched picture data into the filling area you can either set the to a positive value or to a negative value depending on which size you choose to use as a basis ( uses filling area height as a basis and uses picture data height as a basis). To outset the stretched picture data outside of the filling area you can either set the to a negative value or to a positive value depending on which size you choose to use as a basis ( uses filling area height as a basis and uses picture data height as a basis). If the picture is tiled ( is ), then cropped parts of the picture data are covered by the adjacent tiles and all tiles consist of the non-cropped part of the picture data. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the bottom edge of the picture specified as a relative value (percentage of the picture data height, value of 1 is equal to 100% of the picture data height). The offset (inset if the value is positive or outset if the value is negative) of bottom top edge of the picture . To reverse the effect of extra stretching caused because cropped picture data is stretched, increment the by the . To inset the stretched picture data into the filling area you can either set the to a positive value or to a negative value depending on which size you choose to use as a basis ( uses filling area height as a basis and uses picture data height as a basis). To outset the stretched picture data outside of the filling area you can either set the to a negative value or to a positive value depending on which size you choose to use as a basis ( uses filling area height as a basis and uses picture data height as a basis). If the picture is tiled ( is ), then cropped parts of the picture data are covered by the adjacent tiles and all tiles consist of the non-cropped part of the picture data. Gets or sets a value indicating whether the fill should tile as a texture or stretch over the filling area. if fill should tile as a texture; otherwise, to stretch it over the filling area. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the left edge of the stretched picture fill from the left edge of the filling area specified as a relative value (percentage of the filling area width, value of 1 is equal to 100% of the filling area width). The offset (inset if the value is positive or outset if the value is negative) of the left edge of the stretched picture fill from the left edge of the filling area. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the right edge of the stretched picture fill from the right edge of the filling area specified as a relative value (percentage of the filling area width, value of 1 is equal to 100% of the filling area width). The offset (inset if the value is positive or outset if the value is negative) of the right edge of the stretched picture fill from the right edge of the filling area. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the top edge of the stretched picture fill from the top edge of the filling area specified as a relative value (percentage of the filling area height, value of 1 is equal to 100% of the filling area height). The offset (inset if the value is positive or outset if the value is negative) of the top edge of the stretched picture fill from the top edge of the filling area. Gets or sets the offset (inset if the value is positive or outset if the value is negative) of the bottom edge of the stretched picture fill from the bottom edge of the filling area specified as a relative value (percentage of the filling area height, value of 1 is equal to 100% of the filling area height). The offset (inset if the value is positive or outset if the value is negative) of the bottom edge of the stretched picture fill from the bottom edge of the filling area. Gets or sets the additional horizontal offset after tiling alignment. The additional horizontal offset after tiling alignment. Gets or sets the horizontal tiling scale in range from 0 = 0% to 1 = 100%. The horizontal tiling scale. Gets or sets the additional vertical offset after tiling alignment. The additional vertical offset after tiling alignment. Gets or sets the vertical tiling scale in range from 0 = 0% to 1 = 100%. The vertical tiling scale. Gets or sets a value indicating where to align the first tile with respect to the filling area. Alignment happens after the scaling, but before the additional offset. A value indicating where to align the first tile with respect to the filling area. Specifies the direction(s) in which to flip the source image while tiling. Images may be flipped horizontally, vertically, or in both directions to fill the entire region. The direction(s) in which to flip the source image while tiling. Sets the picture data. Path or link to a picture data. if the picture is linked to the file in which instance is saved; otherwise, . An instance of a class that represents the picture data that has been set. is or or doesn't contain extension or extension is not supported. Use this overload to automatically detect the picture content type from the extension. Parameter must contain supported extension (for example, ".png") if is , otherwise exception is thrown. Sets the picture data. Path to a picture data. Image file format of the picture data. An instance of a class that represents the picture data that has been set. is or . Use this overload to explicitly specify image file format (for example, if doesn't specify a file extension). Sets the picture data. Path to a picture data. Content type (MIME type) of the picture data. An instance of a class that represents the picture data that has been set. or is or . Use this overload to explicitly specify picture content type that is not supported by the . Sets the picture data. Stream containing the picture data. An instance of a class that represents the picture data that has been set. is . Picture encoding format is not supported. Use this overload to automatically detect the picture content type from the decoded picture . Sets the picture data. The picture data stream. Image file format of the picture data. An instance of a class that represents the picture data that has been set. is . Use this overload to explicitly specify image file format so that the picture doesn't have to be decoded to detect the picture content type. Sets the picture data. The picture data stream. Content type (MIME type) of the picture data. An instance of a class that represents the picture data that has been set. is . is or . Use this overload to explicitly specify picture content type that is not supported by the . Sets the picture data. The picture content that should be set. An instance of a class that represents the picture data that has been set. is . Use this overload if multiple s should share the same picture data. Sets the picture data. The picture content that should be set. Compression level that the generating application can use as a guidance when optimizing picture data size. An instance of a class that represents the picture data that has been set. is . Use this overload if multiple s should share the same picture data but with different compression levels. Represents an element that is loaded from a file and is not directly supported by GemBox.Document API. This element can appear in document content only if file is loaded with the LoadOptions.PreserveUnsupportedFeatures property set to . For more information, see preservation article and preservation example. Gets the element type for which is . The value. Represents a shape, such as Rectangle or Line. 's type (geometry) is represented by enumeration. It can be set only through constructor and retrieved from property. can be filled with a and outlined with a . can be positioned in-line with the rest of the document content or floating within document content. For more information, see remarks for DrawingElement.Layout property. For more information about shapes and layout, see shapes and layout article and shapes example. GemBox.Document Content Model GemBox.Document Shapes and Layout Shapes example Initializes a new instance of the class. The owner document. Type of the shape. The shape's layout (position and size). is . Gets the type of the shape. The type of the shape. Gets the shape's adjust values. The shape's adjust values. Adjust value is a varying parameter used in calculation of shape's geometry which is specified using Drawing ML. Each defines its own set of adjust values (and some/most do not have any). Shapes and layout article Shapes example Gets the that specifies how the shape's interior is filled. The that specifies how the shape's interior is filled. Shapes and layout article Shapes example Gets the that specifies the shape's outline. The that specifies the shape's outline. Shapes and layout article Shapes example Gets the element type for which is . The value. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents an enumeration of supported built-in shape types. For more information about shapes and layout, see shapes and layout article and shapes example. Shapes and layout article /// Shapes example None. Line. Elbow Connector. Curved Connector. Rectangle. Rounded Rectangle. Snip Single Corner Rectangle. Snip Same Side Corner Rectangle. Snip Diagonal Corner Rectangle. Snip and Round Single Corner Rectangle. Round Single Corner Rectangle. Round Same Side Corner Rectangle. Round Diagonal Corner Rectangle. Oval. Isosceles Triangle. Right Triangle. Parallelogram. Trapezoid. Diamond. Regular Pentagon. Hexagon. Heptagon. Octagon. Decagon. Dodecagon. Pie. Chord. Teardrop. Frame. Half Frame. L-Shape. Diagonal Stripe. Cross. Plaque. Can. Cube. Bevel. Donut. "No" Symbol. Block Arc. Folded Corner. Smiley Face. Heart. Lightning Bolt. Sun. Moon. Cloud. Arc. Double Bracket. Double Brace. Left Bracket. Right Bracket. Left Brace. Right Brace. Right Arrow. Left Arrow. Up Arrow. Down Arrow. Left-Right Arrow. Up-Down Arrow. Quad Arrow. Left-Right-Up Arrow. Bent Arrow. U-Turn Arrow. Left-Up Arrow. Bent-Up Arrow. Curved Right Arrow. Curved Left Arrow. Curved Up Arrow. Curved Down Arrow. Striped Right Arrow. Notched Right Arrow. Pentagon. Chevron. Right Arrow Callout. Down Arrow Callout. Left Arrow Callout. Up Arrow Callout. Left-Right Arrow Callout. Quad Arrow Callout. Circular Arrow. Plus. Minus. Multiply. Division. Equal. Not Equal. Flowchart: Process. Flowchart: Alternate Process. Flowchart: Decision. Flowchart: Data. Flowchart: Predefined Process. Flowchart: Internal Storage. Flowchart: Document. Flowchart: Multidocument. Flowchart: Terminator. Flowchart: Preparation. Flowchart: Manual Input. Flowchart: Manual Operation. Flowchart: Connector. Flowchart: Off-page Connector. Flowchart: Card. Flowchart: Punched Tape. Flowchart: Summing Junction. Flowchart: Or. Flowchart: Collate. Flowchart: Sort. Flowchart: Extract. Flowchart: Merge. Flowchart: Stored Data. Flowchart: Delay. Flowchart: Sequential Access Storage. Flowchart: Magnetic Disk. Flowchart: Direct Access Storage. Flowchart: Display. Explosion 1. Explosion 2. 4-Point Star. 5-Point Star. 6-Point Star. 7-Point Star. 8-Point Star. 10-Point Star. 12-Point Star. 16-Point Star. 24-Point Star. 32-Point Star. Up Ribbon. Down Ribbon. Curved Up Ribbon. Curved Down Ribbon. Vertical Scroll. Horizontal Scroll. Wave. Double Wave. Rectangular Callout. Rounded Rectangular Callout. Oval Callout. Cloud Callout. Line Callout 1. Line Callout 2. Line Callout 3. Line Callout 1 (Accent Bar). Line Callout 2 (Accent Bar). Line Callout 3 (Accent Bar). Line Callout 1 (No Border). Line Callout 2 (No Border). Line Callout 3 (No Border). Line Callout 1 (Border and Accent Bar). Line Callout 2 (Border and Accent Bar). Line Callout 3 (Border and Accent Bar). Action Button: Back or Previous. Action Button: Forward or Next. Action Button: Beginning. Action Button: End. Action Button: Home. Action Button: Information. Action Button: Return. Action Button: Movie. Action Button: Document. Action Button: Sound. Action Button: Help. Action Button: Custom. Curved Connector 2. Curved Connector 4. Curved Connector 5. Bent Connector 2. Bent Connector 4. Bent Connector 5. Line Inverse. Not supported. Use with vertical flip instead. Straight Connector. Chart Plus. Chart Star. Chart X. Corner Tabs. Funnel. Gear 6. Gear 9. Non-Isosceles Trapezoid. Pie Wedge. Plaque Tabs. Square Tabs. Left Circular Arrow. Left-Right Circular Arrow. Swoosh Arrow. Up-Down Arrow Callout. Flowchart: Off-line Storage. Left-Right Ribbon. Custom. The VML TextPath. The block arrow in the shape of a pentagon pointing to the right. Use adjust value 'adj' to specify the length of the arrow tip as a percentage of the height of the whole shape. Adjust value should be in range from 0 to 100000 * Math.Max(width / height, 1). Value of 0 yields very small tip (almost invisible) and value of 100000 * Math.Max(width / height, 1) forms the tip of the same length as the width of the whole shape. Default value is 50000, which means that the arrow tip length will be half of the shape height. Represents a brush which fills an area with a solid color. Shapes and layout article Shapes example Gets or sets the color of this . The color of this . Shapes and layout article Shapes example Represents a set of formatting properties which shall be applied to a . Gets or sets the internal margin. The internal margin. Gets or sets the vertical alignment of the text in the . The vertical alignment of the text in the . Gets or sets a value indicating whether to wrap text in shape. Default value is . This property is not applicable on a within a . if words are wrapped within the bounding rectangle; otherwise, if words spill out without paying attention to the bounding rectangle boundaries. Gets or sets the text auto-fitting setting. Default value is . This property is not applicable on a within a . The text auto-fitting setting. Gets or sets the percentage of the original font size to which each in the is scaled when is . Default value is 1 if is ; otherwise, . This property is not applicable on a within a . The percentage of the original font size to which each in the is scaled when is . Property can be set only if property is . Value is not between 0 and 1. In order to auto-fit text within a bounding box it is sometimes necessary to decrease the font size by a certain percentage. Using this property the font within a text box can be scaled based on the value provided. A value of 1 scales the text to 100%, while a value of 0.01 scales the text to 1%. Gets or sets the percentage amount by which the line spacing of each in the is reduced when is . This property applies only to paragraphs with percentage line spacing. Default value is 0 if is ; otherwise, . This property is not applicable on a within a . The percentage amount by which the line spacing of each in the is reduced when is . Property can be set only if property is . Value is not between 0 and 1. The reduction is applied by subtracting it from the original line spacing value. Using this property the vertical spacing between the lines of text can be scaled by a percent amount. A value of 1 reduces the line spacing by 100%, while a value of 0.01 reduces the line spacing by one percent. Gets or sets the text direction. Default value is . The text direction. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Indicates whether/how to flip the contents of a tile region when using it to fill a larger fill region. Tiles are not flipped. Tiles are flipped horizontally. Tiles are flipped vertically. Tiles are flipped both horizontally and vertically. Represents 2-D transforms for ordinary shapes. Gets or sets the rotation of the shape in degrees. Positive angles are clockwise (i.e., towards the positive y axis); negative angles are counter-clockwise (i.e., towards the negative y axis). The rotation of the shape in degrees. Gets or sets a horizontal flip. When , this property defines that the shape is flipped horizontally about the center of its bounding box. if shape is flipped horizontally about the center of its bounding box; otherwise, . When set to a value different than the current , MS Word automatically inverts the to 360° - (normalized to the interval [0°, 360°>). To follow the MS Word's behavior, you should do the same or simply use the method. Gets or sets a vertical flip. When , this property defines that the shape is flipped vertically about the center of its bounding box. if shape is flipped vertically about the center of its bounding box; otherwise, . When set to a value different than the current , MS Word automatically inverts the to 360° - (normalized to the interval [0°, 360°>). To follow the MS Word's behavior, you should do the same or simply use the method. Inverts the value of the . The is also inverted to 360° - (normalized to the interval [0°, 360°>) like in MS Word. A reference to this instance after the flipping operation has completed. Inverts the value of the . The is also inverted to 360° - (normalized to the interval [0°, 360°>) like in MS Word. A reference to this instance after the flipping operation has completed. Returns a that represents this instance. A that represents this instance. Specifies the relative rectangle. Gets or sets the left edge of the rectangle. The left edge of the rectangle. Value 0 represents 0% while value 1 represents 100%. Gets or sets the top edge of the rectangle. The top edge of the rectangle. Value 0 represents 0% while value 1 represents 100%. Gets or sets the right edge of the rectangle. The right edge of the rectangle. Value 0 represents 0% while value 1 represents 100%. Gets or sets the bottom edge of the rectangle. The bottom edge of the rectangle. Value 0 represents 0% while value 1 represents 100%. Initializes a new instance of the struct. The left. The top. The right. The bottom. Sets the left edge of the rectangle. The left edge of the rectangle. A new instance of the struct with the left edge set to the . Sets the right edge of the rectangle. The right edge of the rectangle. A new instance of the struct with the right edge set to the . Sets the top edge of the rectangle. The top edge of the rectangle. A new instance of the struct with the top edge set to the . Sets the bottom edge of the rectangle. The bottom edge of the rectangle. A new instance of the struct with the bottom edge set to the . Determines whether the   is equal to this instance. The other relative rectangle to compare with this relative rectangle instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this relative rectangle instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Determines whether and  s are equal. The first relative rectangle. The second relative rectangle. if and relative rectangles are equal; otherwise, . Determines whether and  s are not equal. The first relative rectangle. The second relative rectangle. if and relative rectangles are not equal; otherwise, . Represents the end of an editable range permission. element is used in a pair with element to mark a region of the document that specific users or groups are allowed to edit when document protection is active. For and to be considered as a pair, their Ids must match. Initializes a new instance of the class. The owner document. The identifier that pairs this element with a . Gets the identifier that pairs this element with a . Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents the start of an editable range permission. element is used in a pair with element to mark a region of the document that specific users or groups are allowed to edit when document protection is active. For and to be considered as a pair, their Ids must match. Initializes a new instance of the class. The owner document. The identifier that pairs this element with a . Gets the identifier that pairs this element with a . Gets or sets the single user who is allowed to edit this range. The user identifier in one of the following forms: DOMAIN\username, user@domain.com, or username. When set, is ignored. Gets or sets the predefined group of users who are allowed to edit this range. An value. Ignored when is set. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Specifies the predefined group of users that are allowed to edit a range permission. No predefined group is specified; no one is allowed to edit via this group. All users are allowed to edit. Users in the administrators group are allowed to edit. Users in the contributors group are allowed to edit. Users in the editors group are allowed to edit. The currently authenticated user is allowed to edit. Represents a possible set of editing restrictions which may be enforced on a given document. Restrict Editing example Specifies that no editing restrictions have been applied to the document. Specifies that the edits made to this document shall be tracked as revisions. Specifies that the edits made to this document shall be restricted to the insertion and deletion of comments within the document. Specifies that the edits made to this document shall be restricted to editing of form fields. Specifies that the document is read-only (no edits shall be allowed). Represents a base class for all document elements. All document content elements contain properties like , and . These properties are defined on an class - a base class for all document elements. For more information, see GemBox.Document Content Model. GemBox.Document Content Model Gets the content of the current . The content of the current . For more information, see Get Content example. Get Content example Gets the of this instance. The of this instance. Gets the owner document. The owner document. Gets the that contains this instance. The that contains this instance. Gets the parent of this instance. The parent of this instance. Clones this instance, and optionally clones it's descendants. to clone descendants; otherwise . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Gets the child elements. to get all descendants elements; otherwise to get just child elements. Sequence of child elements. Iterating example Gets the child elements filtered by . to get all descendants elements; otherwise to get just child elements. The s to filter by. Sequence of child elements filtered by . Iterating example Gets the parent elements. Sequence of parent elements. Gets the parent elements. The s to filter by. Sequence of parent elements. Represents a base non-generic class for collections. has a covariant public interface, meaning that it contains only common collection methods that are typesafe (methods that do not accept derived parameters). To access all collection methods in a non-typesafe way, cast an to an and use 's members. GemBox.Document Content Model Gets the content of the current . The content of the current . For more information, see Get Content example. Get Content example Gets a sequence of s that can be contained in this collection. A sequence of s that can be contained in this collection. Gets the number of elements contained in the . The number of elements contained in the . Determines the index of a specific in the . The to locate in the . The index of if found in the ; otherwise, -1. Removes the element at the specified index of the . The zero-based index of the element to remove. Removes all elements from the . Gets the at the specified index. The at the specified index. The zero-based index of the to get. The at the specified index. Returns an enumerator that iterates through a collection. An IEnumerator<Element> object that can be used to iterate through the collection. Copies the elements of the to an , starting at a particular index. The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. The zero-based index in at which copying begins. Gets a value indicating whether the is read-only. if the is read-only; otherwise, . Gets a value indicating whether the has a fixed size. if the has a fixed size; otherwise, . Gets a value indicating whether access to the is synchronized (thread safe). if access to the is synchronized (thread safe); otherwise, . Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . Not supported. Gets or sets the element at the specified index. The element at the specified index. The zero-based index of the element to get or set. The element at the specified index. Represents a base generic class for collections. An derived type. GemBox.Document Content Model Gets the number of elements contained in the . The number of elements contained in the . Gets the element at the specified index and casts it to the specified type. The type to cast the element to. The zero-based index of the element to get. The element at the specified index casted to type. This method serves as a utility method for casting. Default C# explicit casting, when used in a chain, makes code hard to write and read. This method makes the chain casting code more clear and maintainable. is less than 0 or is equal to or greater than . An element at the specified index cannot be cast to type . Inserts an element into the at the specified index. The zero-based index at which should be inserted. The element to insert. Adds an object to the end of the . The object to be added to the end of the . Determines whether an element is in the . The element to locate in the . true if item is found in the ; otherwise, false. Searches for the specified element and returns the zero-based index of the first occurrence within the entire . The element to locate in the . The zero-based index of the first occurrence of item within the entire , if found; otherwise, -1. Removes the element at the specified index of the . The zero-based index of the element to remove. Removes the first occurrence of a specific element from the . The element from the . if item is successfully removed; otherwise, . This method also returns if item was not found in the . Removes all elements from the . Gets or sets the element at the specified index. The element at the specified index. The zero-based index of the element to get or set. The element at the specified index. Returns an enumerator that iterates through the . An enumerator for the . Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. The one-dimensional array that is the destination of the elements copied from . The zero-based index in array at which copying begins. Gets a value indicating whether the is read-only. if the is read-only; otherwise, . Represents an element type enumeration. element. element. element. element. element. element. element. element. element. element. element. element. element. element. element. element. element. element. element. element such as break or tab. element. element. element. element. element. element. element. element. element. element. element. element. element. 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. Fields are used in a mail merge and, usually, in scenarios where document information can be resolved only when document is rendered (for example, page numbers). GemBox.Document supports nested fields - another field can be contained in an or a properties of a field. Fields are defined by the Field.FieldType and, optionally, Field.InstructionElements that usually contains field arguments and switches, but can also contain other fields, and Field.ResultElements that contains the latest field's value. For a field creation example, see fields example. GemBox.Document Content Model Gets or sets a value indicating whether the result of this is invalid and, because of that, it should be updated. The property value of true specifies that the result of this field is no longer based on the contents of the document, and should be recalculated whenever an application with this functionality reads the document (for example MS Word). if result of this is invalid and, because of that, it should be updated; otherwise, . Gets or sets a value indicating whether this is locked and, because of that, it should not be updated. When a field is locked, Word application won't update its result. In that case GemBox.Document as well won't update the field result when paginating or rendering the document (to PDF or image). if result of this is locked and, because of that, it should not be updated; otherwise, . Initializes a new instance of the class. The owner document. The field type. Initializes a new instance of the class. The owner document. The field type. The sequence that represents field instruction. The sequence that represents field result. Initializes a new instance of the class. The owner document. The field type. The sequence that represents field instruction. The sequence that represents field result. Initializes a new instance of the class. The owner document. The field type. The sequence that represents field instruction. Initializes a new instance of the class. The owner document. The field type. The field instruction text. The sequence that represents field result. Initializes a new instance of the class. The owner document. The field type. The field instruction text. The sequence that represents field result. Initializes a new instance of the class. The owner document. The field type. The field instruction text. The field result text. Gets or sets the character format. The character format. Gets the field type. The field type. Gets the field instruction s. The field instruction s. This collection is not considered to be a part of document content because field's instructions are a part of field's definition. Because of it, on a will not return in a property. GemBox.Document Content Model Gets the field result s. The field result s. GemBox.Document Content Model Gets the list item or if field doesn't have list item or its is not . The list item or if field doesn't have list item or its is not . Gets the form related data associated with the parent form field or if parent field is not form field. The form related data associated with the parent form field or if parent field is not form field. Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Gets the field instruction text. The field instruction text. Updates the of the current . To update page related fields (, , , and ), and field create an instance of , set its to and call the method with that instance. To update mail merge related fields (, , , etc.) call the method and provide it the data source object. This method currently supports updating following field types: More field types can be expected to be supported in a future versions of GemBox.Document. Clones this instance, and optionally clones it's result. to clone field result; otherwise . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Gets the field instruction s. The field instruction s. This collection is not considered to be a part of document content because field's instructions are a part of field's definition. Its type, , was used as a convenience so we can support both instruction text and nested fields. Because of it, on a will not return in a property. All derived elements are supported in this collection. GemBox.Document Content Model Gets the field result s. The field result s. All derived elements are supported in this collection. GemBox.Document Content Model Represents a field type that is used in defining s. Field type cannot be resolved because does not start with s that specify valid field code. Retrieves the date and time at which the document was created. Retrieves the current date and time. Retrieves the total editing time, in minutes, since the document was created. Retrieves the date and time on which the document was last printed. Retrieves the date and time on which the document was last saved. Retrieves the current date and time. Compares the values designated by two expressions using the designated operator. Field value is 1 if the comparison is true, or 0 if the comparison is false. Inserts the string assigned to the document variable designated by field argument. Inserts a jump command, such that when it is activated, the insertion point of the document is moved to the location specified by field argument. First field argument can be a bookmark, a page number, or some other item. Second field argument is the text or graphic "button" that appears in the document, such that it can be selected to activate the jump. Compares the values designated by two expressions using the designated operator. Field value is first field argument if the comparison is true; otherwise, second field argument. Allows the macro or command designated by first field argument to be run. Second field argument designates the text or graphic to appear as the "button" that is selected to run the macro or command. Sends the printer-specific control code characters specified by field argument to the selected printer. Retrieves, and optionally sets, the document author's name. Retrieves, and optionally sets, the comments relating to the current document. Retrieves the document information indicated by document property category field argument. Retrieves the name of the current document as stored on disk. Retrieves the size of the current document in bytes. A field of this kind is treated as if INFO was omitted and info category field argument was a field-type name. Retrieves, and optionally sets, the document's keywords. Retrieves the name of the user who last modified and saved the current document. Retrieves the number of characters in the current document. Retrieves the number of pages in the current document. Retrieves the number of words in the current document. Retrieves, and optionally sets, the document's subject. Retrieves the disk file name of the template used by the current document. Retrieves, and optionally sets, the document's title. Represents an arbitrary complex arithmetic expression involving constants, bookmarks that refer to expressions, arithmetic and logical operators, functions, values of cells in a table, and fields that result in a single value. Expression can contain grouping parentheses to document the default precedence or to override it. Moves the starting point of text that follows the field to the right or left, up or down, or to a specific horizontal or vertical position. Computes the specified mathematical equation. Retrieves the character whose code point value is specified in decimal or hexadecimal (by using a leading 0x or 0X) in field argument. Builds an index using the index entries specified by XE fields, and inserts that index at this place in the document. Field argument identifies a file to include when creating a table of contents, a table of authorities, or an index using a TOC, TOA, or INDEX field. Defines the text and page number for a table of authorities entry, which is used by a TOA field. Defines the text and page number for a table of contents (including a table of figures) entry, which is used by a TOC field. The text of the entry is field argument. Builds a table of authorities (that is, a list of the references in a legal document, such as references to cases, statutes, and rules, along with the numbers of the pages on which the references appear) using the entries specified by TA fields. Builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, their heading levels, and specified styles, and inserts that table at this place in the document. Defines the text and page number for an index entry, which is used by an INDEX field. The text of the entry is field argument. Inserts the AutoText entry whose name is specified by field argument. Creates a shortcut menu based on AutoText entries in the active template. The list can vary based on the styles applied to the AutoText entries. Field argument is inserted into the document. Retrieves and displays the formatted bibliographic data for all sources in the current document. Displays the formatted contents of the bibliography entry for a source or reference work with a tag name of a source matching field argument. When selected, causes control to jump to the location specified by field argument. That location can be a bookmark or a URL. Retrieves the picture contained in the document named by field argument. Inserts all or part of the text and graphics contained in the document named by first field argument. For information copied from another application, this field links that information to its original source file using OLE. Inserts the mark of the footnote or endnote that is marked by the bookmark specified by field argument. Inserts the number of the page containing the bookmark specified by field argument for a cross-reference. Retrieves the text specified by field argument. Inserts the text or graphics represented by the bookmark specified by field argument. Inserts the nearest piece of text prior to this field that is formatted by the style whose name is specified by field argument. The style can be a paragraph style or a character style. Inserts a mail merge address block. Prompts the user to enter information and assigns the bookmark designated by first field argument to represent the user's response. Second field argument specifies the prompt text, which is displayed in a dialog box. Inserts the results of a database query into a . Prompts the user to enter text. Field argument contains the prompt. Inserts a mail merge greeting line. Retrieves the name of a data field designated by field argument within the merge characters in a mail merge main document. When the main document is merged with the selected data source, information from the specified data field is inserted in place of the merge field. Use this in a mail merge to print the number of the corresponding merged data record in each resulting merged document. The number of data records that were successfully merged with the main document. Merges the next data record into the current resulting merged document, rather than starting a new merged document. Compares the values designated by two expressions using the designated operator. If the comparison is true, the next data record is merged into the current merge document. Merge fields that follow the NEXTIF in the main document are replaced by values from the next data record rather than the current data record. If the comparison is false, the next data record is merged into a new merge document. Defines the bookmark name specified by first field argument to represent the information specified by second field argument. Compares the values designated by two expressions using the designated operator. If the comparison is true, SKIPIF cancels the current merge document, moves to the next in the data source, and starts a new merge document. If the comparison is false, the current merge document is continued. In paragraphs formatted with one of the nine built-in heading styles, paragraph numbering restarts at 1 in each successive heading level. If headings that contain AUTONUM fields are followed by body text paragraphs that also contain AUTONUM fields, the paragraph numbering of the body text is restarted at 1 after each heading. If the headings don't contain AUTONUM fields, body text paragraphs that contain AUTONUM fields are numbered in a continuous, sequential series throughout the document. This field is supported for legacy reasons, it is recommended that LISTNUM be used instead. For legal and technical publications, use the nine built-in heading styles to format headings in the document, and then insert an AUTONUMLGL field at the beginning of each heading paragraph. This field is supported for legacy reasons, it is recommended that LISTNUM be used instead. Use the nine built-in heading styles to format headings in the document, and then insert an AUTONUMOUT field at the beginning of each heading paragraph. This field is supported for legacy reasons, it is recommended that LISTNUM be used instead. Produces a postal bar code that is a machine-readable form of address used by the U.S. Postal Service. Computes the next integral number from the current or a specific series, or a specific number from the next or specific series. Retrieves the number of the current page. Retrieves the document's revision number (which indicates the number of times the document has been saved). Retrieves the number of the current section. Retrieves the number of the current page within the current section. Sequentially numbers chapters, tables, figures, and other user-defined lists of items in a document. Retrieves the current user's postal address or, if field argument is present, the address specified by field argument. Specifying a field argument shall not change the address of the current user. Retrieves the current user's initials or, if field argument is present, the initials specified by field argument. Specifying a field argument shall not change the initials of the current user. Retrieves the current user's name or, if field argument is present, the name specified by field argument. Specifying a field argument shall not change the name of the current user. Inserts a check box style form field which, when the editing of form fields is enabled, can be checked and unchecked. Inserts a drop-down list style form field which, when the editing of form fields is enabled, can be used to select an entry in the list. Inserts a text box style form field which, when the editing of form fields is enabled, can be typed into. Renders a generated barcode symbol using the data in this display field. This field is analogous to the field code, . The main difference is that generates a field based on the merge result instead of showing it directly. The syntax of field instruction and supported switches is also different. Represents a floating which is used to embed document element in a page outside of the main content flow. Main content flow is usually wrapped around embedded element. Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Gets or sets the horizontal position. The horizontal position. Gets or sets the vertical position. The vertical position. Gets or sets the setting for how text is wrapped around the floating element. The setting for how text is wrapped around the floating element. Default value is . Gets or sets the setting for how text can wrap around the floating element's left and right sides. The setting for how text can wrap around the floating element's left and right sides. Default value is . Gets or sets the distances between the edges of a floating element and any subsequent text within the document. The distances between the edges of a floating element and any subsequent text within the document. Default value is: Top: 0 cm, Bottom: 0 cm, Left: 0.32 cm, Right: 0.32 cm. Initializes a new instance of the class with the specified horizontal position, vertical position and size of a floating element. The horizontal position of a floating element. The vertical position of a floating element. The size of a floating element. Always gets a value because member's type is . value because member's type is . Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Represents a font file either on the disk or in the memory. GlyphTypeface class Gets the font family name. The font family name. GlyphTypeface.FamilyNames property Gets a value indicating whether the characters in a font are truly (Italic) or artificially (Oblique) slanted. Default value is . if the characters in a font are slanted; otherwise, . FontStyles class Gets the integer value between 1 and 999 that represents OpenType font weight. Default value is 400. Bold value is 700. The integer value between 1 and 999 that represents OpenType font weight. FontWeights class Gets the integer value between 1 and 9 that represents OpenType font widths. Default value is 5. The integer value between 1 and 9 that represents OpenType font widths. FontStretches class Determines whether the font file contains outlines for the specified Unicode character. The Unicode character. if the font file contains outlines for the specified Unicode character; otherwise, . Determines whether the   is equal to this instance. The other font file to compare with this font file instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this font file instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Provides data for the event. Gets the original font name. The original font name. Gets a value indicating whether the font is italic. if the font is italic.; otherwise, . Gets a value indicating whether the font is bold. if the font is bold; otherwise, . Gets the Unicode character that should be outlined with the or -1 if no character should currently be outlined. The Unicode character that should be outlined with the or -1 if no character should currently be outlined. Gets the instance on which the event was invoked on. The instance on which the event was invoked on. Gets or sets the actual font that will be used for outlining the based on the , and values. Use any of the fonts returned from the collection of the . The actual font that will be used for outlining the based on the , and values. Value is . The specified font file does not contain outlines for the specified . Represents a font used in the document. Gets the name of the font The name of the font. Represents a collection of s in this document. Gets the number of s contained in the . The number of s contained in the . Gets the at the specified index. The at the specified index. The zero-based index of the to get. The at the specified index. Removes the first occurrence of a specific element from the . The element from the . true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the . Removes all elements from the . Contains font related settings which are used when printing, importing or exporting a document to a file format that requires font information. Setting the custom fonts location is usually used in environments without any installed fonts. For more information, see the Private Fonts example. Gets all the fonts loaded in the current application domain that are usable with GemBox.Document component. All the fonts loaded in the current application domain that are usable with GemBox.Document component. Gets or sets the base where component looks for fonts. path should end with or . The base where component looks for fonts. Gets or sets the base directory path where component looks for fonts. Directory path can be absolute or relative to . The base directory path where component looks for fonts. Gets or sets the base resource location where component looks for fonts specified as resources inside the local or referenced assembly. The base resource location where component looks for fonts specified as resources inside the local or referenced assembly. Packaging Fonts with Applications Pack URIs in WPF Occurs when the must be selected based on the font name, style and weight used in the document and when the fallback font must be selected (if the current does not contain outlines for the ). Gets all fonts usable with the current instance. All fonts usable with the current instance. Gets or sets the base where the current instance looks for fonts. path should end with or . The base where the current instance looks for fonts. Gets or sets the base directory path where the current instance looks for fonts. Directory path can be absolute or relative to . The base directory path where the current instance looks for fonts. Gets or sets the base resource location where the current instance looks for fonts specified as resources inside the local or referenced assembly. The base resource location where the current instance looks for fonts specified as resources inside the local or referenced assembly. Occurs when the must be selected based on the font name, style and weight used in the document and when the fallback font must be selected (if the current does not contain outlines for the ). Represents a base class for all formats. For more information, see formats and styles. GemBox.Document Formats and Styles Gets the owner document. The owner document. Clears the formatting. This method will clear all directly set formatting values. When retrieving formatting value, they can still come from other sources, as explained in formats and styles article. Represents a form related data associated with the parent field within the document. Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Gets or sets the exact size for the parent Check Box form field in points. If value is , then parent Check Box form field shall be sized automatically using the point size which is applied via the style hierarchy. The exact size for the parent Check Box form field in points or if parent Check Box is automatically sized via the style hierarchy. Gets or sets the default Check Box state for the parent Check Box form field. Default value is (Check Box is unchecked). if default state for the parent Check Box form field is checked; otherwise, . Gets or sets the current state for a Check Box form field or if state is not explicitly set. The current state for a Check Box form field or if state is not explicitly set. Gets the current state for a Check Box form field if state is explicitly set; otherwise, the default state. The current state for a Check Box form field if state is explicitly set; otherwise, the default state. Represents a form related data associated with the parent field within the document. Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Gets or sets the zero-based index of the default entry for the parent drop-down list form field. The zero-based index of the default entry for the parent drop-down list form field. Gets or sets the zero-based index of the currently selected entry for the parent drop-down list form field or if selected entry is not explicitly set. The zero-based index of the currently selected entry for the parent drop-down list form field or if selected entry is not explicitly set. Gets the list entry items within the parent drop-down list form field. The list entry items within the parent drop-down list form field. Gets the currently selected entry for the parent drop-down list form field if selected entry is explicitly set; otherwise, . The currently selected entry for the parent drop-down list form field if selected entry is explicitly set; otherwise, . Gets the currently selected entry for the parent drop-down list form field if selected entry is explicitly set; otherwise, default entry. The currently selected entry for the parent drop-down list form field if selected entry is explicitly set; otherwise, default entry. Represents a form related data associated with the parent form field within the document. Associated parent form field may be of any of the following types (with the associated FieldType and FormData type in parentheses) Text Box ( - )Check Box ( - )Drop-down List ( - ) Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Gets the parent form field. The parent form field. Gets or sets the name of the form field. The name of the form field. Gets or sets a value indicating whether the parent form field shall behave as though it is enabled or disabled when it is displayed in the document. Default value is . if parent form field shall behave as though it is enabled when it is displayed in the document; otherwise, . Gets or sets a value indicating whether the content of all fields within the document shall be recalculated from their field codes when the content of the parent form field is modified. if the content of all fields within the document shall be recalculated from their field codes when the content of the parent form field is modified; otherwise, . Gets or sets the subroutine in a scripting language which should be executed when the value of the parent form field is entered. The subroutine in a scripting language which should be executed when the value or content of the parent form field is entered. Gets or sets the subroutine in a scripting language which should be executed when the value of the parent form field is exited. The subroutine in a scripting language which should be executed when the value of the parent form field is exited. Gets or sets the optional help text which shall be associated with the parent form field. The optional help text which shall be associated with the parent form field. Gets or sets a value indicating whether should be interpreted as the name of a glossary document entry whose contents contain the help text. if should be interpreted as the name of a glossary document entry whose contents contain the help text; otherwise, if should be interpreted as the literal text for the help text, . Gets or sets the optional status text which shall be associated with the parent form field. The optional status text which shall be associated with the parent form field. Gets or sets a value indicating whether should be interpreted as the name of a glossary document entry whose contents contain the status text. if should be interpreted as the name of a glossary document entry whose contents contain the status text; otherwise, if should be interpreted as the literal text for the status text, . Gets the value of this form field explicitly set by the user or , if value was not explicitly set. Type of the value depends on form field type as explained in remarks. The value of this form field explicitly set by the user or , if value was not explicitly set. Type of the value depends on form field type, form field properties (such as ) and whether the textual value of form field is parse-able into required type as explained in the following table:
Form field type ( derived type)Form field propertiesValue type
FORMTEXT () is
FORMTEXT () is or
FORMTEXT () is or
FORMTEXT () is
FORMCHECKBOX ()
FORMDROPDOWN ()
If textual value of form field is not parse-able into required type, then textual value is returned. Read Form example Gets the value of this form field explicitly set by the user or default value, if value was not explicitly set. Type of the value depends on form field type as explained in remarks. The value of this form field explicitly set by the user or default value, if value was not explicitly set. Resets the of this form field instance. FORMTEXT fields with equal to , and are currently not reset. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents a collection of instances associated with form fields from a particular part of document content. Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Gets or sets a value indicating whether a visual cue should be displayed around form fields contained in a document. Default value is . if a visual cue should be displayed around form fields contained in a document; otherwise, . Gets the associated with the form field with the specified name or if no form field with the specified name exists in the current range. The associated with the form field with the specified name or if no form field with the specified name exists in the current range. The name of the form field. Gets all instances associated with form fields with the specified name. The name of the form field. A sequence of all instances associated with form fields with the specified name. Resets all form fields contained in this collection. Returns an enumerator that iterates through the . An enumerator for the . Represents a form related data associated with the parent field within the document. Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Gets or sets the type of the contents of the current text box form field. Default value is . The type of the contents of the current text box form field. Gets or sets the default string for the parent text box form field. The default string for the parent text box form field. This string is the content which shall be displayed in the document story within this form field if its current run contents are empty (i.e. there is not actual content within the text box). If the of the current form field is , then this string shall hold the calculation to be performed. Gets or sets the field formatting which shall be applied to the contents of the parent form field whenever those contents are modified. The field formatting which shall be applied to the contents of the parent form field whenever those contents are modified. Gets or sets the maximum length of text which should be allowed within the parent text box form field before any formatting specified by the property. Default value is int.MaxValue (unlimited). The maximum length of text which should be allowed within the parent text box form field before any formatting specified by the property. Gets or sets the current value for a text form field. The current value for a text form field. Represents the possible types of the contents of a text box form field. Create Word Form Controls in C# and VB.NET Read Word Form Controls in C# and VB.NET Update Word Form Controls in C# and VB.NET Specifies that this text form field is a plain text field (no additional content restrictions). Specifies that the contents of this text box form field shall be treated as a number value. Specifies that the contents of this text box form field shall be treated as a date. Specifies that the contents of this text box form field shall be the current date when the field is updated. Specifies that the contents of this text box form field shall be the current time when the field is updated. Specifies that the contents of this text box form field shall be the result of the field calculation specified by the corresponding property. Provides data for the event. Gets or sets the choice for proceeding when free limit is reached. The choice for proceeding when free limit is reached. Gets the document on which limit was reached. The document on which limit was reached. Type of action that can be chosen when free limit is reached. Throw . Stop reading/writing. Continue reading/writing using trial mode. Exception that occurs when free limit is reached. Represents the possible types of grid mode for a section. No document grid shall be applied to the contents of the corresponding section in the document. Specifies that the corresponding section will have additional line pitch added to each line in order to maintain the specified number of lines per page. Specifies that the corresponding section will have both the additional line pitch and character pitch added to each line and character in order to maintain a specific number of lines per page and characters per line. Characters will not be automatically aligned with gridlines. Specifies that the corresponding section will have both the additional line pitch and character pitch added to each line and character in order to maintain a specific number of lines per page and characters per line. Characters will be automatically aligned with gridlines. Represent a header / footer for the parent . is a special document content element that is not a part of a main document content, instead, it is repeated at the beginning (if is ) or at the end of every page (first page, even pages or all pages) that is showing the parent 's content. is a content element containing of derived elements that can be accessed through HeaderFooter.Blocks property. For more information, see GemBox.Document Content Model. For more information about headers and footers, see header / footer example. Section.HeadersFooters GemBox.Document Content Model Initializes a new instance of the class. The owner document. Type of the header / footer. Initializes a new instance of the class. The owner document. Type of the header / footer. The header / footer content. Initializes a new instance of the class. The owner document. Type of the header / footer. The header / footer content. Gets the type of the header / footer. The type of the header / footer. Gets a value indicating whether this instance is header. if this instance represents header; if this instance represents footer. Gets the that contains this instance. The that contains this instance. Gets the parent of this instance. The parent of this instance. Gets the header / footer content. The header / footer content. Supports and elements. GemBox.Document Content Model Gets or sets the watermark for this . Setting the property to null removes the existing watermark. The watermark for this . Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Clones this instance and sets new . The new header/footer type. Cloned . Represents a collection of elements. cannot contain multiple elements with equal HeaderFooter.HeaderFooterType. Following rules apply for headers / footers contained in a collection: / - header / footer will be applied to every page in a section. / - header / footer will be applied to only even pages in a section. Overrides / on even pages, if also contained in a collection. / - header / footer will be applied to only first page in a section. Overrides both / and / on first page, if also contained in a collection. GemBox.Document Content Model Gets the with the specified type. Returns if collection doesn't contain with the specified type. The with the specified type or if collection doesn't contain with the specified type. The header / footer type. The with the specified type or if collection doesn't contain with the specified type. Gets the that corresponds to the given . Gets the that corresponds to the given . If doesn't contain correspondent header or footer element, then the element will be added and returned. The instance. that corresponds to the given . Sets whether the specified header or footer type is linked to the corresponding header or footer in the previous section. The type of header or footer to link. Must be a valid value. to link the specified header or footer type to the previous section; to unlink it. Determines whether the specified header or footer type is linked to the corresponding type in the previous section. The type of header or footer to check. if the specified header or footer type is linked to the corresponding type in the previous section; otherwise, . Specifies the type of the . Following rules apply for headers / footers contained in a collection: / - header / footer will be applied to every page in a section. / - header / footer will be applied to only even pages in a section. Overrides / on even pages, if also contained in a collection. / - header / footer will be applied to only first page in a section. Overrides both / and / on first page, if also contained in a collection. Default header. If doesn't contain definition of default header then pages will have empty header (header will not have any content). Header for even pages. If doesn't contain definition of even header then even pages will have default header. Header for the first page in section. If doesn't contain definition of header for the first page then first page will have default header. Default footer. If doesn't contain definition of default footer then pages will have empty footer (footer will not have any content). Footer for even pages. If doesn't contain definition of even footer then even pages will have default footer. Footer for the first page in section. If doesn't contain definition of footer for the first page then first page will have default footer. Horizontal alignment. Left alignment. Centered alignment. Right alignment. Justified alignment. Represents a horizontal positioning which can be expressed with enumeration or value. Initializes a new instance of the struct with specified absolute position. The absolute position in units specified by parameter in direction to the right of location specified by parameter. The measurement unit for absolute position value. The location from which absolute position is offset from. If parameter is positive, offset is to the right of specified by parameter, otherwise offset is to the left. Initializes a new instance of the struct with specified alignment. The alignment relative to specified by parameter. The location from which parameter is relative to. Gets the base location of this horizontal position. The base location of this horizontal position. Gets the horizontal position type which can either be absolute or relative. The horizontal position type which can either be absolute or relative. Gets the horizontal position absolute value in points if is , otherwise value is not applicable. The horizontal position absolute value in points if is , otherwise value is not applicable. Determines whether the   is equal to this instance. The other horizontal position to compare with this horizontal position instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this horizontal position instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first horizontal position. The second horizontal position. if and horizontal positions are equal; otherwise, . Determines whether and  s are not equal. The first horizontal position. The second horizontal position. if and horizontal positions are not equal; otherwise, . This constructor is obsolete. Use any other constructor which accepts as parameter instead. Initializes a new instance of the struct. The horizontal position value. The horizontal position type. 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. Specifies that the parent object shall be horizontally anchored to the text margins. Specifies that the parent object shall be horizontally anchored to the page edge. Specifies that the parent object shall be horizontally anchored to the text extents. Specifies that the horizontal positioning shall be relative to the position of the anchor within its run content. This value can be used only for positioning s. Specifies that the horizontal positioning shall be relative to the left margin of the page. This value can be used only for positioning s. Specifies that the horizontal positioning shall be relative to the right margin of the page. This value can be used only for positioning s. Specifies that the horizontal positioning shall be relative to the inside margin of the current page (the left margin on odd pages, right on even pages). This value can be used only for positioning s. Specifies that the horizontal positioning shall be relative to the outside margin of the current page (the right margin on odd pages, left on even pages). This value can be used only for positioning s. Specifies that the horizontal positioning shall be relative to the top left corner of the parent. Represents a set of possible relative horizontal positions for the parent floating element. This relative position is specified relative to the horizontal anchor specified by the parent . Specifies that the parent object should have absolute horizontal positioning with respect to the anchor settings. Specifies that the parent object shall be left aligned with respect to the anchor settings. Specifies that the parent object shall be centered with respect to the anchor settings. Specifies that the parent object shall be right aligned with respect to the anchor settings. Specifies that the parent object shall be inside of the anchor object. Specifies that the parent object shall be outside of the anchor object. Represents a class that stores loading options for HyperText Markup Language (HTML) format. Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Occurs when external resources, like images and style sheets, are being loaded and can be used to customize the retrieving of linked resources. Initializes a new instance of the class. Gets or sets the encoding for the HTML file. The encoding for the HTML file. Value is set to . Gets or sets the base address for images with relative location. The base address for images with relative location. Images with relative location such as <img src="Pictures/MyPicture.jpg"/> or <img src="../../Pictures/MyPicture.jpg"/> are read based from or path parameter if DocumentModel.Load(string) or DocumentModel.Load(string, LoadOptions) method is used. This property is useful if HTML document is loaded from with DocumentModel.Load(Stream, LoadOptions) method and contains images with relative locations. Gets or sets a value indicating whether the character format should be inherited from the position where the HTML is being inserted. The default value is . This property is currently used only when loading HTML with . and . methods and is ignored when loading the whole HTML file using . methods. Gets or sets a value indicating whether the paragraph format should be inherited from the position where the HTML is being inserted. The default value is . This property is currently used only when loading HTML with . and . methods and is ignored when loading the whole HTML file using . methods. Gets or sets the type of HTML which should be imported. The value for the type of HTML which should be imported. Valid HTML types when importing are and . Gets or sets the media type used for applying CSS styles when loading HTML. The default value is "print". The media type, such as "screen" or "print". Represents options for saving to HyperText Markup Language (HTML) format. Pictures are exported only if one of this is true: is or overload is used or is specified Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets or sets the physical directory where s will be saved. The physical directory where s will be saved. If value is or and HTML export is called with or overload, value will be automatically set to htmlFileNameWithoutExtension + "_files". This directory will be created in the same location as HTML file. Gets or sets the relative directory that will be used when referencing s in the HTML. The relative directory that will be used when referencing s in the HTML. If value is or and HTML export is called with or overload, value will be automatically set to htmlFileNameWithoutExtension + "_files". Gets or sets the type of export. The value for type of export. For and values, pictures will be exported only if or overload is used or if is specified or if is set to . For value, pictures are always exported. Gets or sets a value indicating whether images are embedded directly within the HTML file in form of Base64 encoding. if images are embedded directly within the HTML file in form of Base64 encoding; otherwise, . If the value of this property is then each image element will contain raw image data in its source attribute. This value doesn't change the pictures export behavior when using . Gets or sets a value indicating whether s whose is not are exported as . if s whose is not are exported as ; otherwise, . Gets or sets a value indicating whether to keep linked images as links. if linked images should be kept as links; otherwise, . If the value is set to , all linked images in the model will not be downloaded to . They will be exported to HTML with original source paths. Otherwise, images will be downloaded and their links will be replaced with local paths. Gets or sets a value indicating whether CID (Content-ID) should be used to reference images within MHTML file. to reference images with Content-ID headers, to reference images with Content-Location headers. Some MHTML viewers fail to load image resources when they're referenced with Content-Location headers, for example MS Outlook. In that case, try exporting the images with CID references by setting to . Gets or sets a value indicating whether to use semantic elements when generating an HTML. To maintain backward compatibility, default value is . The type of the semantic element that will be used is inferred either from a document element type, some of its properties or its style. For example, <h1> to <h6> HTML elements will be used for paragraphs with 'Heading 1' to 'Heading 6' styles. This feature is currently not fully implemented. Support for various HTML semantic elements (especially those defined in HTML5) will be added gradually. if semantic HTML elements should be used when generating an HTML; otherwise, . Gets or sets a value indicating whether to ignore styling information when generating an HTML. Use this property if you want that generated HTML contains only HTML elements without any style attributes. Default value is meaning that document element's styling information will be written to output HTML. if styling information should be ignored when generating an HTML; otherwise, . Initializes a new instance of the class. Gets the content-type for HTML file format: message/rfc822 if is , otherwise"text/html; charset=" + .. The content-type for HTML file format. Gets or sets the encoding for the HTML file. The encoding for the HTML file. Value is set to . Defines the type of HTML. Entire HTML document. HTML content inline, without html, head and body tags. This options is only valid when exporting to HTML. Entire HTML document and images in MIME HTML (MHTML) format. Represents an that can be used to create a link to an external resource or to a inside a document. is an element. For more information about GemBox.Document Content Model, see content model. can contain any other element except in its Hyperlink.DisplayInlines content property. For an example how to create a to a , see Bookmarks and Hyperlinks example. Hyperlinks exported to XPS file format do not provide navigational capabilities. GemBox.Document Content Model Gets or sets a value indicating whether this instance is bookmark link. if this instance is bookmark link; otherwise, . Gets or sets the screen tip. The screen tip. Gets or sets the target frame. The target frame. Supported values are: _blank, _parent, _self, _top or frame name. Initializes a new instance of the class. The owner document. The address that identifies external resource such as URL, or bookmark name. The sequence that represents hyperlink display elements. Initializes a new instance of the class. The owner document. The address that identifies external resource such as URL, or bookmark name. The sequence that represents hyperlink display elements. Initializes a new instance of the class. The owner document. The address that identifies external resource such as URL, or bookmark name. The hyperlink display text. Gets or sets the hyperlink address. The hyperlink address. Can contain an URI string or a name. Gets the hyperlink display s. The hyperlink display s. All derived elements except are supported in this collection. GemBox.Document Content Model Clones this instance, and optionally clones it's display elements. to clone hyperlink display elements; otherwise . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Creates the hyperlink-styled . The owner document. The run text. The hyperlink-styled . Represents the hyphenation options for the . Gets or sets a value indicating whether automatic hyphenation is turned on for the specified document. if automatic hyphenation is turned on for the specified document; otherwise, . Gets or sets a value indicating whether words in all capital letters can be hyphenated. if words in all capital letters can be hyphenated; otherwise, . Initializes a new instance of the class. Gets or sets the maximum number of consecutive lines that can end with hyphens. Consecutive hyphens limit value can be between 0 and 32767. Default value is 0. The maximum number of consecutive lines that can end with hyphens. Gets or sets the width of the hyphenation zone, in points. Default value is 18 points (0.25 inch). The width of the hyphenation zone, in points. The hyphenation zone is the maximum amount of space left between the end of the last word in a line and the right margin. Clones this instance. Cloned . Represents a base class for the hyphenation dictionary classes. Hyphenates a specific word. A word to be hyphenated. A list of positions in a word where it can be hyphenated. Represents a collection of instances associated with specified culture information. Occurs when a hyphenation dictionary is being loaded for the specified culture information. This event must be handled in cases when no hyphenation dictionary was found for the specified culture information. Gets or sets the value associated with the specified key. The value associated with the specified key. The key of the value to get or set. The value associated with the specified key. Gets a collection containing the keys in the . A collection containing the keys in the . Gets a collection containing the values in the . A collection containing the values in the . Gets the number of key/value pairs contained in the . The number of key/value pairs contained in the . Adds the specified key and value to the . The key of the element to add. The value of the element to add. Removes the value with the specified key from the . The key of the element to remove. true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found in the . Removes all keys and values from the . Determines whether the contains the specified key. The key to locate in the . true if the contains an element with the specified key; otherwise, false. Gets the value associated with the specified key. The key of the value to get. When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the parameter. This parameter is passed uninitialized. true if the contains an element with the specified key; otherwise, false. Represents data for an event that occurs when no hyphenation dictionary was found for the specified culture information. Gets the dictionary's culture information. The dictionary's culture information. Gets or sets the hyphenation dictionary for the specified culture information. The hyphenation dictionary for the specified culture information. Represent a TeX hyphenation dictionary. Loads a hyphenation dictionary from a file with the specified path. The path from which to load a hyphenation dictionary. A loaded hyphenation dictionary. Loads a hyphenation dictionary from the specified stream. The stream from which to load a hyphenation dictionary. A loaded hyphenation dictionary. Represents an that can contain other s underneath itself. For more information, see content model article. GemBox.Document Content Model Gets a sequence of s that are contained under this . A sequence of s that are contained under this . For more information, see content model article. GemBox.Document Content Model An enumeration of supported image file formats when saving a document's page to an image using a . Bitmap (BMP) format. Graphics Interchange Format (GIF). Joint Photographic Experts Group (JPEG) format. Portable Network Graphics (PNG) format. Tagged Image File Format (TIFF). Windows Media Photo format. Scalable Vector Graphics (SVG) format. Enhanced Metafile Format. Represents a class which stores saving options for image files. For more information about a level of support for image formats, see supported file formats. Gets or sets the image format. The image format. Gets or sets the image width in pixels. The image width in pixels. If both and are not specified, then image size will be equal to the page size. If only one of the or is specified, then the specified dimension will be respected and other dimension will be calculated so that original aspect ratio is maintained. If both and are specified, then both specified dimensions will be respected (which may result in non-uniformly scaled image, if aspect ratio is not equal to the original one. Gets or sets the image height in pixels. The image height in pixels. If both and are not specified, then image size will be equal to the page size. If only one of the or is specified, then the specified dimension will be respected and other dimension will be calculated so that original aspect ratio is maintained. If both and are specified, then both specified dimensions will be respected (which may result in non-uniformly scaled image, if aspect ratio is not equal to the original one. Gets or sets a pixel format, which will be used for the image. The pixel format, which will be used for the image. Gets or sets the value that indicated whether dithering should be applied when converting to pixel formats , , and . Default value: . This property is currently ignored when is resolved to . if dithering should be applied when converting to pixel formats , , and ; otherwise, . Gets or sets compression schema, which will be used when exporting to Tagged Image File Format (TIFF). The compression schema, which will be used when exporting to Tagged Image File Format (TIFF). Gets or sets the number of pages which should be saved. The number of pages which should be saved. Only formats that support multiple frames (Tagged Image File Format (TIFF) and Graphics Interchange Format (GIF)) are supported. If image format doesn't support multiple frames, this property is ignored. The default value is 1. Gets or sets a value indicating whether the image should be cropped to fit the content of the document. If set to , only the content of the document is rendered, without headers or footers. Gets or sets the font-related settings used when saving the document to an image file format. If this property is , then static members of the are used to resolve font-related settings. The font-related settings used when saving the document to an image file format. Occurs when saving progress of a document has changed. Gets or sets the rendering mode used when saving the content to an image. The rendering mode used when saving the content to an image. The rendering mode is not supported because of the reasons explained in the exception's . Gets or sets a value indicating whether to do text layout using advanced text formatting implementation such as those from Windows Presentation Foundation (WPF) or HarfBuzz text-shaping engine, or to use the default primitive implementation. Default value is for improved performance and stability of the output because advanced text formatting is required only for complex scripts or advanced typography features. to do text layout using advanced text formatting implementation; otherwise to use the default primitive implementation. Initializes a new instance of the class. Initializes a new instance of the class for a specific image format. The image format. Gets or sets the horizontal dots per inch (dpi) of the image. Default value is , which means that component specific default value will be used (currently 300). The horizontal dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the x-axis. Value is not greater than 0. Gets or sets the vertical dots per inch (dpi) of the image. Default value is , which means that component specific default value will be used (currently 300). The vertical dots per inch (dpi) of the image; that is, the dots per inch (dpi) along the y-axis. Value is not greater than 0. Gets the content-type for image file format: image/png if is ,image/jpeg if is ,image/gif if is ,image/bmp if is ,image/tiff if is ,image/vnd.ms-photo if is ,image/svg+xml if is .image/x-emf if is . The content-type for image file format. Represents a mapping of styles (and other referenced objects) from source document to destination document when importing elements between two different instances. Same instance can be used for multiple imports. This improves performances because matching styles (mapping from source document style to destination document style) do not have to be identified in subsequent imports if they where matched in previous imports. It also reduces memory usage and provides more consistent behavior in some particular scenarios which involve importing list paragraphs, list styles and paragraph styles which contain list formatting. Gets the source document. The source document. Gets the destination document. The destination document. Gets a value indicating whether to use destination document styles if they have the same name as source document styles, even though they do not have the same formatting. to use destination document styles; otherwise, . Destination document and with . equal to are never used, because that would continue numbering of imported paragraphs in destination document and thus imported paragraphs would influence on the numbering of the rest of the paragraphs in destination document. If imported paragraphs with specific should continue numbering in destination document, then set explicit mapping from source (of these imported paragraphs) to destination onto which numbering should continue. Gets a value indicating whether to fully resolve formatting on elements. to fully resolve formatting; otherwise, . If this property is set to , even if a formatting property wasn't explicitly set in the source document, it will be resolved from the style or the document's default formats. This is useful when merging multiple documents with different default formats. Default value is . Initializes a new instance of the class. The source document. The destination document. to use destination document styles if it has the same name as source style (but doesn't have the same formatting); otherwise to use source document styles. or is . Initializes a new instance of the class. The source document. The destination document. to use destination document styles if it has the same name as source style (but doesn't have the same formatting); otherwise to use source document styles. to fully resolve formatting on elements from styles and document default formats; otherwise . or is . Gets the destination that matches the specified source style. The source style. The destination that matches the specified source style or if source style was not yet matched to any destination style. Sets the destination that matches the specified source style. The source style. The destination that matches the specified source style. is . Source and destination style are not of the same type. Gets existing or new destination that matches the specified source style. The source style. The destination that matches the specified source style. Represents a base class for all inline elements, like , , , , , , and . Inline elements are contained in the same line with other inline elements that are in the same . Inline elements, predominantly s, are contained in a or other inline content elements, such as or a . For more information, see GemBox.Document Content Model. GemBox.Document Content Model Gets the that contains this instance. The that contains this instance. Gets or sets the revision information for the inline. The revision information for the inline. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a collection of derived elements. Although is a strongly typed collection of a derived elements, not all derived elements are supported in every . For example, Paragraph.Inlines and Field.ResultElements support all derived elements, and Hyperlink.DisplayInlines doesn't support element. Supported element types can be retrieved through property. For more information, see GemBox.Document Content Model. GemBox.Document Content Model Represents an in-line which is used to embed document element in the current line of the main content flow. Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Initializes a new instance of the class with the specified size. The size of the in-line embedded element. Always gets a value because member's type is , not . value because member's type is , not . Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Represents a base class for specifying element's layout properties, such as position and size. Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Gets or sets the value indicating whether the aspect ratio is locked. if aspect ratio is locked; otherwise, . Default value of this property is . Gets or sets the size. The size. Gets or sets the additional padding added to each edge of the element (top, bottom, left, right) in order to compensate for any drawing effects applied to the element. The additional padding added to each edge of the element (top, bottom, left, right) in order to compensate for any drawing effects applied to the element. is currently not supported when exporting a document to PDF, XPS, or image formats. Gets or sets the transformation. The transformation. Gets a value indicating whether element which has this instance applied is floating around page main content. if element which has this instance applied is floating around page main content; otherwise, . Drawing elements (, or ) can be embedded / positioned (by using DrawingElement.Layout property): In line with the text ( type) - affects the line height and layout of its line (like a character glyph of similar size). Floating within the text relative to the page ( type) - affects the layout of its surrounding content which is either wrapped around or in-front / behind the floating element. Besides position, embeddable element must also have size specified. Drawing element's position and size are contained in DrawingElement.Layout property. Embedded element's layout can be specified by either instantiating appropriate derived type, such as or , or by using factory methods Layout.Inline() or Layout.Floating(). For more information, see Shapes and Layout article. Shapes and Layout article Pictures example Text Boxes example Shapes example Creates a layout used when element should be embedded in-line with the rest of the content. The size of the embedded element. A new instance of an type which contains all in-line embedded element's layout-related properties. Creates a layout used when element should be embedded in-line with the rest of the content. The width of the embedded element. The height of the embedded element. The measurement unit used for and . A new instance of an type which contains all in-line embedded element's layout-related properties. Creates a layout used when element should be floating in a document page and rest of the page content should wrap around it. The horizontal position of a floating element. The vertical position of a floating element. The size of a floating element. A new instance of a type which contains all floating element's layout-related properties. Represents the measurement unit for measuring length or distance. All dimensional formatting properties in GemBox.Document are represented in s. To convert values between various s, use . Point (1 inch is equal as 72 points). Pixel (1 inch is equal as 96 pixels). Inch (1 inch is equal as 72 points). Millimeter (10 millimeters are equal as 1 centimeter). Centimeter (1 inch is around 2.54 centimeters). Pica (1 pica is equal as 12 points). Twip (twentieth of a point, 1 point is equal as 20 twips). English Metric Unit (1 point is equal as 12,700 EMUs) Utility class used for converting values between various measurement units. All dimensional formatting properties in GemBox.Document are represented in s. For more information, see unit conversion example. Converts the specified from measurement unit to measurement unit. The length that will be converted. The source measurement unit. The destination measurement unit. The expressed in measurement unit. Exception that occurs when licensing information is not correctly specified. Represents line number restart setting. Don't show line numbers. Continue line numbering from previous section. Restart line numbering for each page. Restart line numbering for each section. Specifies line spacing rule for a paragraph. The line spacing needs to be at least value specified by the LineSpacing property (in points). The line spacing is exactly value specified by the LineSpacing property (in points). The line spacing is value specified by the LineSpacing property (as the number of lines). Represents list format which shall be applied to the contents of the parent paragraph. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. GemBox.Document Formats and Styles Initializes a new instance of the class. Gets or sets the . The list style. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets a value indicating whether this defines the list. if this instance defines the list; otherwise, . Gets or sets the list level number for the parent paragraph. The list level number. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets the that is applied on the parent . The that is applied on the parent . List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Clones this instance. If then the Numbering Definition Instance referenced by this will also be cloned. This is useful to reset the while maintaining the rest of the . Cloned . Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Determines whether the specified is equal to this instance. The to compare with this list format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first list format. The second list format. if and list formats are equal; otherwise, . Determines whether and  s are not equal. The first list format. The second list format. if and list formats are not equal; otherwise, . Represents content which prefixes numbered paragraph ( for which is ). List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets the paragraph which this prefixes or if this represents the value of a field. The paragraph which this prefixes or if this represents the value of a field. Gets the paragraph which this prefixes or field whose value is this . The paragraph which this prefixes or field whose value is this . Gets the list of numbers calculated by counting list paragraphs and their indentation levels. The list of numbers calculated by counting list paragraphs and their indentation levels. Gets the content of this instance. The content of this instance. Returns a textual representation of this instance. A textual representation of this instance. Represents formatting definition which specifies the appearance and behavior of a list level. A list level contains a set of properties for the display of the numbering for a given list level. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets the level of this . The level of this . This value is a zero-based index of the number of list levels in the document. For example, a value of 2 is the 3rd list level in the document. Gets or sets the starting number for this list level. The starting number for this list level. This value is used when this level initially starts in a document, as well as whenever it is restarted via the property. Default value is 0. Gets or sets the number style. The number style. This property specifies the number style which shall be used to display all numbering at this level. This information is used to replace the level text string %x in property, where x is a particular one based level index, with the appropriate value. This value shall be calculated by counting the number of paragraphs at this level since the last restart using the numbering system defined in this property. Default value is . Gets or sets the list level that must appear before the specified list level restarts numbering. The list level that must appear before the specified list level restarts numbering. This property specifies a one-based index which determines when a list level should restart to its value. A list level restarts when an instance of the specified list level, which shall be higher (earlier than the this level) is used in the given document's contents. Default value is zero-based level of this which means that list level shall restart each time the previous list level is used. If the specified level is higher than the current level, then this element shall be ignored. As well, a value of 0 shall specify that this level shall never restart. Gets or sets the which shall use this list level when applied to the contents of the document. The which shall use this list level when applied to the contents of the document. When a is defined to include a , any list level defined by shall be ignored, and instead this property shall specify the list level associated with that . Default value is which means that no is associated with this list level. Gets or sets the value which specifies whether or not all previous levels displayed for a given list level's text specified in the property shall be displayed using the (Arabic numerals), regardless of the actual of that level in the list. The value which specifies whether or not all previous levels displayed for a given list level's text specified in the property shall be displayed using the (Arabic numerals), regardless of the actual of that level in the list. If this property is , then all list levels present in the property shall be converted to their decimal equivalents when they are displayed in this level. If this property is , then each level is displayed using the of that level. Default value is . Gets or sets the value which specifies the content which shall be added between a given list level's text specified in the property and the text of every numbered paragraph which references that list level. The value which specifies the content which shall be added between a given list level's text specified in the property and the text of every numbered paragraph which references that list level. Default value is . Gets or sets a value which specifies the textual content which shall be displayed when displaying a paragraph with the given list level. A value which specifies the textual content which shall be displayed when displaying a paragraph with the given list level. All text in this property's value shall be taken as literal text to be repeated in each instance of this list level, except for any use of the percent symbol (%) followed by a number, which shall be used to indicate the one-based index of the number to be used at this level. Any number of a level higher than this level shall be ignored. When the % syntax is used, the number shall be incremented for each subsequent paragraph of that level (sequential or not), until the restart level is seen between two subsequent paragraphs of this level. Default value is . Gets or sets a picture which shall be used as a list symbol for a given list level. A picture which shall be used as a list symbol for a given list level. The picture shall be added to the list level by replacing each character in the with one instance of this image. Default value is . Gets or sets the horizontal alignment used on a list level's text specified in the property within a given list level. The horizontal alignment used on a list level's text specified in the property within a given list level. supports only , and horizontal alignment. This alignment is applied relative to the text margin of the parent numbered paragraph in the document. Default value is . Gets the paragraph format which shall be applied as part of a given list level. This paragraph format is applied to any numbered paragraph that uses this list level. The paragraph format which shall be applied as part of a given list level. Paragraph format properties specified on the numbered paragraph itself override the paragraph format properties specified on a list level used by that paragraph. Gets or sets the character format which shall be applied to the list level's text specified in the property when it is applied to paragraphs in this document. The character format which shall be applied to the list level's text specified in the property when it is applied to paragraphs in this document. This character format is applied to all numbering level text used by a list level. It should be noted that character format specified on a numbered paragraph itself, or on text runs within a numbered paragraph, are separate from the character format specified within a list level, as the latter affects only the numbering text itself, not the remainder of runs in the numbered paragraph. Gets or sets the position (in points) of the number or bullet for the list level. The number position. This property is shorthand for . property. Gets or sets the position (in points) of the text. The text position. This property is shorthand for . property. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Determines whether the specified is equal to this instance. The to compare with this list level format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first list level format. The second list level format. if and list level formats are equal; otherwise, . Determines whether and  s are not equal. The first list level format. The second list level format. if and list level formats are not equal; otherwise, . Represents a read-only collection of list level formatting. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Represents a list style which can be applied to one or more s within document content. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. GemBox.Document Formats and Styles Initializes a new instance of the class. The style name. Specifies the template from which this list style will be initialized. Initializes a new instance of the class. Specifies the template from which this list style will be initialized. , Gets or sets the to be used when this is referenced. The to be used when this is referenced. This doesn't contain any list level format, they are all inherited from . If list level format of this is changed, then its is set to . supports style inheritance of depth one only (this is limitation of Office Open XML specification). Gets the formatting for each list style level. The formatting for each list style level. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Specifies one of the predefined list formats. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Bullet for a first level is disc. Bullet for a first level is circle. Bullet for a first level is square. Bullet for a first level is diamond. Bullet for a first level is arrow. Bullet for a first level is checkmark. The number of the first level is "a)". The number of the first level is "1.". The number of the first level is "1)". The number of the first level is "I.". The number of the first level is "A.". The number of the first level is "a.". The number of the first level is "i.". List levels don't have symbols. Specifies trailing character that will be inserted after the number. Tab. Space. Nothing. Represents a base class for loading options of various file formats. To preserve unsupported file format features, set to . For more information, see preservation. DocumentModel.Load methods Open and read Word file in C# and VB.NET Read and Extract PDF Text in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets or sets a value indicating whether to preserve file format features that are not directly supported through GemBox.Document object model. to preserve file format features that are not directly supported through GemBox.Document object model; otherwise, . Default value is set to . For more information, see preservation. Gets the default loading options for Microsoft Word (DOCX) format. The default loading options for Microsoft Word (DOCX) format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for Microsoft Word 97-2003 (DOC) format. The default loading options for Microsoft Word 97-2003 (DOC) format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for HyperText Markup Language (HTML) format. The default loading options for HyperText Markup Language (HTML) format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for Open Document (ODT) format. The default loading options for Open Document (ODT) format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for Rich Text (RTF) format. The default loading options for Rich Text (RTF) format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for Portable Document Format (PDF). The default loading options for Portable Document Format (PDF). This property always returns a new instance of class initialized with default constructor. Gets the default loading options for Plain Text (TXT) format. The default loading options for Plain Text (TXT) format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for XML file format. The default loading options for XML file format. This property always returns a new instance of class initialized with default constructor. Gets the default loading options for Markdown (MD) format. The default loading options for Markdown (MD) format. This property always returns a new instance of class initialized with default constructor. Represents a dictionary that is used in mail merge when s and data source columns have different names. Keys and values cannot be or . Key comparison is case-insensitive. GemBox.Document Mail Merge Adds a new mapping from field name to data source column name. The field name. The data source column name. Provides data for the event. For more information, see customize mail merge example. GemBox.Document Mail Merge Gets the s that will replace the . The s that will replace the . Gets or sets the that will replace the . The that will replace the . Value of this property depends on a value of the property. If is not empty, this property represents the first element from it, otherwise . Setting this property will automatically clear collection and will add new value to it, if value is not . Gets the owner document. The owner document. Gets the that will be replaced. The that will be replaced. Gets the field name if Field type is , otherwise (if it is , or ) . The field name if Field type is , otherwise (if it is , or ) . To successfully retrieve field name, Field.InstructionElements must contain only s. Field's instruction text is then constructed by calling Field.GetInstructionText method and field name is parsed from the instruction text. For more information, see customize mail merge example. Gets the data source value for a specified . The data source value for a specified . Gets a value indicating whether a value was found in the data source. if a value was found in the data source; otherwise, . Gets the mail merge execution context. The mail merge execution context. Gets the data source record number. The data source record number. Record number starts from 1, not 0. Gets the mail merge range name. The mail merge range name. Represents a mail merge data source. By adapting your custom data source to implement this interface, you can use it as a data source in mail merging. For more information, see mail merge. GemBox.Document Mail Merge Gets the data source name. Used in ranged mail merging. The data source name. Moves to the next record in the data source. if next record is available; otherwise . Tries to get the value with a name (column / property / relation name) equal to from the current record in data source. The value (column / property /relation) name. The value. if the current record has a value with a name equal to . Represents a class that is used for mail merging - an operation by which may work in conjunction with data from an external data source, importing this data into a according to a set of codes contained in known as s. can be accessed through property. Mail merge can be executed with a variety of data source types on a whole document or a named part of the document. For more information, see mail merge. For mail merge examples, see mail merge examples. GemBox.Document Mail Merge Occurs when is merging with data source value and can be used to customize the merging operation. Customize Mail Merge example GemBox.Document Mail Merge Gets or sets the mail merge clear options. The mail merge clear options. Mail Merge Clear Options example Gets the owner document. The owner document. Gets or sets the range start prefix that signals the mail merge engine that following s are a part of a named range. The range start prefix that signals the mail merge engine that following s are a part of a named range. GemBox.Document Mail Merge Gets or sets the range end prefix that signals the mail merge engine that named range has ended. The range end prefix that signals the mail merge engine that named range has ended. GemBox.Document Mail Merge Gets or sets a string that specifies the prefix of a merge field name. If the merge field name starts with this prefix, the merge field will be merged as a picture. The default value is "Picture:". Prefix that specifies merge field, which should be merged as a picture. Picture mail merge Gets or sets the base path for pictures used during picture merging. The base path for pictures used during picture merging. Picture mail merge Gets the mappings from field names to data source column names. The mappings from field names to data source column names. Keys and values cannot be or . Key comparison is case-insensitive. GemBox.Document Mail Merge This property is obsolete. Use .. or .. instead. Gets or sets the default formatting culture used when formatting field values. The default formatting culture used when formatting field values. For more information, see GemBox.Document Mail Merge Formatting. GemBox.Document Mail Merge Formatting Removes all mail merge related fields (, , , , and fields). GemBox.Document Mail Merge Removes the s with value of or from the owning . if set to all other mail merge related fields are removed, such as , , and fields. GemBox.Document Mail Merge Gets the merge field names. A sequence of a merge field names. GemBox.Document Mail Merge Executes a mail merge operation with specified data source. The mail merge data source. Range name is extracted from the as describe in mail merge article. GemBox.Document Mail Merge Executes a mail merge operation with specified range name and data source. The mail merge range name. The mail merge data source. GemBox.Document Mail Merge This property is obsolete. Use MailMerge.ClearOptions property with MailMergeClearOptions.RemoveEmptyRanges value instead. Gets or sets a value indicating whether to remove mail merge ranges into which no data has been imported. to remove mail merge ranges into which no data has been imported; otherwise, . GemBox.Document Mail Merge This method is obsolete. Use method instead. The mail merge data source. This method is obsolete. Use method instead. The mail merge range name. The mail merge data source. Mail merge options used to specify if unused fields or empty ranges or empty paragraphs should be removed in the mail merge process. Mail Merge Clear Options example Do not remove unused fields nor empty ranges nor empty paragraphs. Remove fields for which no data has been found in the mail merge data source. Remove ranges into which no field has been merged. Remove paragraphs which contained merge fields but none of them has been merged. Remove table rows which contained merge fields but none of them has been merged. Remove tables which contained merge fields but none of them has been merged. Represents the mail merge execution context. Gets the mail merge range name. The mail merge range name. Gets the that represents the start of the mail merge range. The that is the start of the mail merge range. Gets the that represents the end of the mail merge range. The that is the end of the mail merge range. Gets the parent mail merge execution context or if this is the root mail merge execution context. The parent mail merge execution context or if this is the root mail merge execution context. Gets the data source record index. The data source record index. Record index starts from 0. Gets the data source record. The data source record. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and format of its return value might change in future versions. Represents a class that stores loading options for Markdown (MD) format. Occurs when external resources, like images, are being loaded and can be used to customize the retrieving of linked resources. Initializes a new instance of the class. Gets or sets the encoding for the Markdown file. The encoding for the Markdown file. Value is set to . Gets or sets the base address for images with relative location. The base address for images with relative location. Represents options for saving to Markdown (MD) format. Pictures are exported only if one of the following is true: or overload is used or is specified Initializes a new instance of the class. Gets the content-type for Markdown file format: "text/markdown; charset=" + .. The content-type for Markdown file format. Gets or sets the encoding for the Markdown file. The encoding for the Markdown file. Value is set to . Gets or sets the physical directory where s will be saved. The physical directory where s will be saved. If value is or and Markdown export is called with or overload, value will be automatically set to markdownFileNameWithoutExtension + "_files". This directory will be created in the same location as the Markdown file. Gets or sets the relative directory that will be used when referencing s in the Markdown. The relative directory that will be used when referencing s in the Markdown. If value is or and Markdown export is called with or overload, value will be automatically set to markdownFileNameWithoutExtension + "_files". Gets or sets a value indicating whether images are embedded directly within the Markdown file as Base64-encoded data URIs. if images are embedded directly within the Markdown file as Base64-encoded data URIs; otherwise, . Represents an area in a document between multiple start and end s. Gets the s that mark the beginning of the current . The returned list contains multiple elements if the current starts inside multiple table cells of a table. Otherwise, the returned list contains only one element. Gets the s that mark the end of the current . The returned list contains multiple elements if the current ends inside multiple table cells of a table. Otherwise, the returned list contains only one element. Represents a set of borders. class is used to set borders for , and elements. To enumerate through all supported border types, use property. Gets the supported border types. The supported border types. Converts a flags enumeration to a sequence of enumeration. A flags enumeration. A sequence of enumeration. Sets the specified borders. The border types to set. The border style. The border color. The border width in points. Sets the specified borders. The border types to set. The border style. The border color. The border width in points. the border spacing offset in points. Clears the specified borders. The border types to clear. Clears all borders. Gets the for the specified . The for the specified . Type of the border. The for the specified . Determines whether the specified is equal to this instance. The to compare with this borders instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first borders. The second borders. if and borders are equal; otherwise, . Determines whether and  s are not equal. The first borders. The second borders. if and borders are not equal; otherwise, . Sets the specified borders. This method is required to support C# collection initializer syntax and redirects its call to the method. The border types to set. The border style. The border color. The border width in points. class explicitly implements and contains public method so it can be initialized using the C# collection initializer syntax like in the following example. Returns an enumerator that iterates through all s supported in this instance. interface is required to support C# collection initializer syntax. An object that can be used to iterate through the collection. class explicitly implements and contains public method so it can be initialized using the C# collection initializer syntax like in the following example. Represents multiple border types. No border. Left border. Top border. Right border. Bottom border. Inside horizontal border. Inside vertical border. Diagonal down border (from top-left to bottom-right). Diagonal up border (from bottom-left to top-right). Outside borders (left, top, right and bottom borders). Inside borders (inside horizontal and inside vertical borders). Diagonal borders (diagonal up and diagonal down borders). All borders (outside, inside and diagonal borders). Represents a footnote or an endnote in the document. can be configured using on a document level ( and ) or on a section level ( and . Document level settings are cloned when new is added to the . PDF format has the following limitations: Footnotes are always rendered on the same page as their references. Footnotes that don't fit on a single page are clipped. Note numbering setting is not supported. HTML and TXT formats have the following limitations: All footnotes and then endnotes are exported at the end of the document. Note numbering setting is not supported. Gets the 's blocks. The 's blocks. Supports all derived elements: , and . GemBox.Document Content Model Gets or sets the note type. The note type. Gets or sets the custom mark. The custom mark. If not null or empty, custom mark will be used as a note mark instead of automatically generated value determined by . Initializes a new instance of the class with specified note type. The owner document. The note type. Initializes a new instance of the class with specified note type and specified text. The owner document. The note type. The text content for this instance. Initializes a new instance of the class with specified note type and specified blocks. The owner document. The note type. The content. Initializes a new instance of the class with specified note type and specified blocks. The owner document. The note type. The content. Gets or sets the note mark character format. The note mark character format. This property is defined as direct formatting, since it is directly applied to the run and supersede any formatting from styles. For more information about paragraph formatting, see character formatting example. Represents the note rendering location. Bottom of page. Below text or content. End of document. End of section. Represents note numbering mode. Continuous. Resets numbering on each section to start at the number specified in the . Resets numbering on each page to start at the number specified in the . Represents the footnote or endnote options of a or . Gets or sets the note rendering location. The note rendering location. Value not supported by current settings type (footnote or endnote). Gets or sets the number of columns in the note rendering area. The number of columns in the note rendering area. Value must be in the range from 0 to 4. Value is out of range. Gets or sets the note mark number style. The note mark number style. Value not supported. Gets or sets the note numbering mode. The note numbering mode. Value not supported by current settings type (footnote or endnote). Gets or sets the note mark start number. The note mark start number. Value must be a positive number. Represents type. Footnote. Endnote. Specifies the form in which to display numeral spacing. Specifies that numerals are displayed in the font’s default form. Specifies that the forms of the numerals designed as proportionally spaced are displayed if supported by the font. Specifies that the forms of the numerals designed as tabular are displayed if supported by the font. Represents the number style. Decimal number. Upper Roman number. Lower Roman number. Upper letter. Lower letter. Bullet. None. Specifies that the sequence shall consist of Arabic numbering with a zero added to numbers one through nine. Example: 01, 02, 03, …, 09, 10. Chicago Manual of Style (*, † ...) Japanese counting system (一, 二, ...) Chinese counting system Chinese counting thousand system Decimal numbers enclosed in a circle Represents a class that stores saving options for Portable Document Format (PDF) file. For more information about a level of support for PDF format, see supported file formats. For more information about PDF encryption, see remarks. Convert Word and HTML to PDF in C# and VB.NET Gets or sets the operations that are allowed to a user on an encrypted PDF document. The operations that are allowed to a user on an encrypted PDF document. Generated PDF document will be encrypted if any of the following conditions are satisfied: is different than . is not or . is not or . Both and are optional but with the following consequences: If is different than and is not specified, component will generate random . Using , also known as owner password, without is not secure. It relies on PDF viewer software to respect specified restrictions, but it may choose not to do so. Using , also known as user password, is potentially very secure. It or is required for decrypting and viewing the document. When is specified, PDF viewer application will prompt for password to decrypt and present the document. If entered password is , document will be decrypted and presented with specified enforced. Otherwise, if entered password is , document will be decrypted and presented without any restrictions. and cannot be equal, otherwise exception is thrown. For more information, see PDF Encryption example. PDF Encryption example Specifies the password required for opening the encrypted PDF document. The password required for opening the encrypted PDF document. Generated PDF document will be encrypted if any of the following conditions are satisfied: is different than . is not or . is not or . Both and are optional but with the following consequences: If is different than and is not specified, component will generate random . Using , also known as owner password, without is not secure. It relies on PDF viewer software to respect specified restrictions, but it may choose not to do so. Using , also known as user password, is potentially very secure. It or is required for decrypting and viewing the document. When is specified, PDF viewer application will prompt for password to decrypt and present the document. If entered password is , document will be decrypted and presented with specified enforced. Otherwise, if entered password is , document will be decrypted and presented without any restrictions. and cannot be equal, otherwise exception is thrown. For more information, see PDF Encryption example. PDF Encryption example Specifies the password for opening the encrypted PDF document without any access restrictions. The password for opening the encrypted PDF document without any access restrictions. Generated PDF document will be encrypted if any of the following conditions are satisfied: is different than . is not or . is not or . Both and are optional but with the following consequences: If is different than and is not specified, component will generate random . Using , also known as owner password, without is not secure. It relies on PDF viewer software to respect specified restrictions, but it may choose not to do so. Using , also known as user password, is potentially very secure. It or is required for decrypting and viewing the document. When is specified, PDF viewer application will prompt for password to decrypt and present the document. If entered password is , document will be decrypted and presented with specified enforced. Otherwise, if entered password is , document will be decrypted and presented without any restrictions. and cannot be equal, otherwise exception is thrown. For more information, see PDF Encryption example. PDF Encryption example Gets or sets a value indicating whether to create PDF bookmarks (outlines). Default value: (for backward compatibility). A value indicating whether to create PDF bookmarks (outlines). Gets or sets the saved images DPI. The saved images DPI. This property controls the image quality for all images in the file. Larger value results in better-quality images but increases the file size. Setting this property to 0 will disable image optimization. Standard DPI values are: 330 - Good quality for HD displays 220 - Good quality for most printers and displays 150 - Good quality for web pages and projectors 96 - Good quality for smaller file sizes Using this property you basically specify the DPI of the display device on which the file will be viewed and for which the images in the file should be optimized without losing any perceived quality because images go through the same resampling (reduction of pixel count) as they would in the viewer application if viewing the file using the default (100%) zoom factor on that display device. For example, if an image whose pixel size is 600px × 400px is shown on page where it occupies a slot whose physical size is 150pt × 100pt, then if the display device DPI is 144px/inch, the viewer application will show the image in a display slot whose pixel size is 300px × 200px if the default (100%) zoom factor is used (Rationale: there are always 72 points per inch and for the DPI of 144, there are 144 pixels per inch, so 150[pt] = 150[pt] × 144[px/inch] / 72[pt/inch] = 300[px]).
So the viewer application has to fit an image into a smaller display slot and it will do so by resampling the image from 600px × 400px to 300px × 200px.
Reducing the total number of pixels 4 times (from 240000 to 60000) would also reduce the image file size, so GemBox component can do this instead of the viewer application, thus achieving the overall smaller file size without any perceived loss of quality since the same image resampling would have been done by the viewer application anyway if the default (100%) zoom factor is used.
Instructing the GemBox component to perform image resampling (by setting the property to the DPI of the display device on which the file is going to be viewed) has two effects: Major benefit: output file size will be smaller if there are images whose pixel size is greater than their display size because those images are resampled to a smaller number of pixels without any perceived loss of quality since the same resampling would have been done by the viewer application anyway. Minor benefit: viewer application will be able to present the image faster because it needs to decode a fewer number of pixels and because the display slot size will be exactly equal to the image pixel size so it doesn't have to perform any resampling if the default (100%) zoom factor is used. Gets or sets the level of conformance for PDF document. The level of conformance for PDF document. Gets or sets a value indicating whether to rasterize vector pictures. The value indicating whether to rasterize vector pictures. Occurs when saving progress of a document has changed. Gets or sets a value indicating whether to do text layout using advanced text formatting implementation such as those from Windows Presentation Foundation (WPF) or HarfBuzz text-shaping engine, or to use the default primitive implementation. Default value is for improved performance and stability of the output because advanced text formatting is required only for complex scripts or advanced typography features. to do text layout using advanced text formatting implementation; otherwise to use the default primitive implementation. Initializes a new instance of the class. Gets or sets the digital signature options. The digital signature options. PDF digital signature examples Gets the content-type for PDF file format: application/pdf. The content-type for PDF file format. Gets or sets the version of the PDF specification to which the PDF document conforms specified in the PDF file's header (see 7.5.2, "File Header"). Note that the PDF file's header version might be coerced to a value higher than the one specified in if the PDF file uses features that are not supported by the version specified in . If the value is then PDF file's header version will be automatically set to a specific value depending on the features used in the PDF file. Default value: . The version of the PDF specification to which the PDF document conforms specified in the PDF file's header. Gets or sets the font-related settings used when saving the document to the PDF file format. If this property is , then static members of the are used to resolve font-related settings. The font-related settings used when saving the document to the PDF file format. Represents a picture. is a that enables inserting a bitmap, which consists of the pixel data for a graphics image and its attributes, within a document content. Picture.PictureStream and Picture.Format properties define a and are mandatory in a constructors, directly or indirectly. can be clipped to a specific shape. Clipping shape type is represented by enumeration. It can be set only through constructor and retrieved from property. can be filled with a (which will be visible if picture has transparent pixel data) and outlined with a . can be positioned in-line with the rest of the document content or floating within document content. For more information about picture positioning, see remarks for DrawingElement.Layout property. For more information, see pictures example. GemBox.Document Content Model GemBox.Document Shapes and Layout Pictures example This property is obsolete. Use Picture.Layout property instead. If value is TextWrappingStyle.InLineWithText, set it to instance of , otherwise cast or set it to instance of and set FloatingLayout.WrappingStyle property instead. Gets or sets how text is wrapped around a picture. The wrapping style. This property is obsolete. Use Picture.Layout.Size.Width property instead. To change a width, use new instance of struct. Gets or sets the width in points. The width in points. This property is obsolete. Use Picture.Layout.Size.Height property instead. To change a height, use new instance of struct. Gets or sets the height in points. The height in points. This property is obsolete. Use Picture.Layout property instead. Cast or set it to instance of and use FloatingLayout.HorizontalPosition property instead. Gets or sets the horizontal position for the . The horizontal position. This property is obsolete. Use Picture.Layout property instead. Cast or set it to instance of and use FloatingLayout.HorizontalPosition property instead. To change horizontal position base, use new instance of struct. Gets or sets the base point for the horizontal positioning. The base point for the horizontal positioning. This property is obsolete. Use Picture.Layout property instead. Cast or set it to instance of and use FloatingLayout.VerticalPosition property instead. Gets or sets the vertical position for the . The vertical position. This property is obsolete. Use Picture.Layout property instead. Cast or set it to instance of and use FloatingLayout.VerticalPosition property instead. To change vertical position base, use new instance of struct. Gets or sets the base point for the vertical positioning. The base point for the vertical positioning. This property is obsolete. Use Picture.Layout property instead. Cast or set it to instance of and use FloatingLayout.WrapText property instead. Gets or sets how text shall wrap around the object's left and right sides. The type of the wrap text. Gets or sets the stream that contains the image. The stream that contains the image. Gets or sets the link to the external picture. The link to the external picture. Gets the image file format. The image file format. Initializes a new instance of the class. The owner document. Stream that contains the image. This constructor decodes image data (for getting and calculating width and height in points). This approach slightly impairs performance (decoding an image requires around 20-50ms for larger images) so, if performance is crucial or you need to insert a lot of images, use constructors that accept argument. Initializes a new instance of the class with specified layout (position and size), clipping geometry and picture's pixel data stream. The owner document. Stream that contains the image. The picture layout (position and size). The picture's shape type into which picture will be clipped. Initializes a new instance of the class with specified layout (position and size) and picture's pixel data stream and format. The owner document. Stream that contains the image. The picture stream format. The picture layout (position and size). Initializes a new instance of the class with specified layout (position and size), clipping geometry and picture's pixel data stream and format. The owner document. Stream that contains the image. The picture stream format. The picture layout (position and size). The picture's shape type into which picture will be clipped. Initializes a new instance of the class. The owner document. Stream that contains the image. The image file format. The picture width (in points). The picture height (in points). Initializes a new instance of the class positioned in-line with specified picture's pixel data stream and format and picture's size. The owner document. Stream that contains the image. The picture stream format. The picture width in units specified by parameter. The picture height in units specified by parameter. The measurement unit for and . Initializes a new instance of the class. The owner document. Stream that contains the image. The picture width (in points). The picture height (in points). Initializes a new instance of the class positioned in-line with specified picture's pixel data stream and picture's size. The owner document. Stream that contains the image. The picture width in units specified by parameter. The picture height in units specified by parameter. The measurement unit for and . Initializes a new instance of the class. The owner document. The file path to the image. This constructor decodes image data (for getting and calculating width and height in points). This approach slightly impairs performance (decoding an image requires around 20-50ms for larger images) so, if performance is crucial or you need to insert a lot of images, use constructors that accept argument. Initializes a new instance of the class. The owner document. The file path to the image. If set to picture won't be embedded in the document, instead will be a link to the external picture. This constructor decodes image data (for getting and calculating width and height in points). This approach slightly impairs performance (decoding an image requires around 20-50ms for larger images) so, if performance is crucial or you need to insert a lot of images, use constructors that accept argument. Initializes a new instance of the class. The owner document. The file path to the image. The picture width (in points). The picture height (in points). Initializes a new instance of the class. The owner document. The file path to the image. The picture width (in points). The picture height (in points). If set to picture won't be embedded in the document, instead will be a link to the external picture. Initializes a new instance of the class positioned in-line with specified picture's pixel data file path and picture's size. The owner document. The picture pixel data file path. The picture width in units specified by parameter. The picture height in units specified by parameter. The measurement unit for and . Initializes a new instance of the class positioned in-line with specified picture's pixel data file path and picture's size. The owner document. The picture pixel data file path. The picture width in units specified by parameter. The picture height in units specified by parameter. The measurement unit for and . If set to picture won't be embedded in the document, instead will be a link to the external picture. Initializes a new instance of the class linked to the external image. The owner document. The file path to the image. The picture format. The picture width (in points). The picture height (in points). If set to picture won't be embedded in the document, instead will be a link to the external picture. If is , this constructor results in a element in which image data is lazily loaded on getter. Initializes a new instance of the class linked to the external image. The owner document. The file path to the image. The picture format. The picture width in units specified by parameter. The picture height in units specified by parameter. The measurement unit for and . If set to picture won't be embedded in the document, instead will be a link to the external picture. If is , this constructor results in a element in which image data is lazily loaded on getter. Gets or sets the properties for displaying an online video to the user. The properties for displaying an online video to the user. Gets the element type for which is . The value. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Specifies information about how a document is printed. Print Word files in C# and VB.NET Initializes a new instance of the class. Initializes a new instance of the class. Initializes a new instance of the class by using an XML stream (that contains a document) that complies with the XML Print Schema. Print Word files in C# and VB.NET Gets or sets the number of copies of the document to print. The number of copies of the document to print. Value must be positive. Gets or sets the number of pages that print on each printed side of a sheet of paper. The number of pages that print on each printed side of a sheet of paper. Value must be 1, 2, 4, 6, 8 or 16. Only a limited range of 1, 2, 4, 6, 8 or 16 pages per sheet side are supported. Gets or sets the page index of the first page to print. The page index of the first page to print. Value cannot be negative. Document pages are zero-indexed meaning that first page in the document has index 0 (zero). Gets or sets the index of the last page to print. The index of the last page to print. Value cannot be lower than . Use value to print to the last page. Gets or sets the font-related settings used when printing the document. If this property is , then static members of the are used to resolve font-related settings. The font-related settings used when printing the document. Gets or sets the name of the printed document in the print queue. Default value is 'Document'. The name of the printed document in the print queue. Gets or sets a value indicating whether to do text layout using advanced text formatting implementation such as those from Windows Presentation Foundation (WPF) or HarfBuzz text-shaping engine, or to use the default primitive implementation. Default value is for improved performance and stability of the output because advanced text formatting is required only for complex scripts or advanced typography features. to do text layout using advanced text formatting implementation; otherwise to use the default primitive implementation. Represents a vertical positioning which can be expressed with enumeration or value. This constructor is obsolete. Use any other constructor which accepts as parameter instead. Initializes a new instance of the struct. The vertical position value. The vertical position type. Initializes a new instance of the struct with specified absolute position. The absolute position in units specified by parameter in direction below of the location specified by parameter. The measurement unit for absolute position value. The location from which absolute position is offset from. If parameter is positive, offset is below of specified by parameter, otherwise offset is above. Initializes a new instance of the struct with specified alignment. The alignment relative to specified by parameter. The location from which parameter is relative to. Gets the base location of this vertical position. The base location of this vertical position. Gets the vertical position type which can either be absolute or relative. The vertical position type which can either be absolute or relative. Gets the vertical position absolute value in points if is , otherwise value is not applicable. The vertical position absolute value in points if is , otherwise value is not applicable. Determines whether the   is equal to this instance. The other vertical position to compare with this vertical position instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this vertical position instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first vertical position. The second vertical position. if and vertical positions are equal; otherwise, . Determines whether and  s are not equal. The first vertical position. The second vertical position. if and vertical positions are not equal; otherwise, . Represents a class that stores saving options for XML Paper Specification (XPS) file. For more information about a level of support for XPS format, see supported file formats. Gets or sets the rendering mode used when saving the content to an XML Paper Specification (XPS) file. The rendering mode used when saving the content to an XML Paper Specification (XPS) file. The rendering mode is not supported because of the reasons explained in the exception's . Gets or sets a value indicating whether to do text layout using advanced text formatting implementation such as those from Windows Presentation Foundation (WPF) or HarfBuzz text-shaping engine, or to use the default primitive implementation. Default value is for improved performance and stability of the output because advanced text formatting is required only for complex scripts or advanced typography features. to do text layout using advanced text formatting implementation; otherwise to use the default primitive implementation. Initializes a new instance of the class. Gets or sets the font-related settings used when saving the document to the XPS file format. If this property is , then static members of the are used to resolve font-related settings. The font-related settings used when saving the document to the XPS file format. Gets the content-type for XPS file format: application/vnd.ms-xpsdocument. The content-type for XPS file format. Represents a class that stores loading options for Open Document (ODT) format. Initializes a new instance of the class. Represents a class that stores saving options for Open Document file. Gets the content-type for ODT file format: application/vnd.oasis.opendocument.text. The content-type for ODT file format. Represents an OLE (Object Linking and Embedding) object embedded or linked within a document. Gets the content type of the embedded object data. The content type of the embedded object data. Gets the element type for which is . The value. Gets or sets the preview picture or the icon () associated with the OLE object. The preview picture or the icon () representing the OLE object. Gets or sets a value indicating whether this object or control is linked. if this object or control is linked; otherwise, if it is embedded. Gets or sets a value indicating whether the object is displayed as an icon or using its native representation. if the object is displayed as an icon; otherwise, if it is displayed using its native representation. Gets or sets the original width of the image representing the OLE object. Gets or sets the original height of the image representing the OLE object. Gets or sets the update type for the linked object. Gets the program identifier (ProgId) associated with the OLE object. Gets the path or link associated with the OLE object. Thrown if the path cannot be determined if the object is linked with a null link. Gets the link associated with the OLE object, if it is linked. Gets the data of the embedded object. The data of the embedded object. Initializes a new instance of the class with the specified document, stream, path, layout, and content type. The document model. The stream containing the embedded object data. The original path or file name of the embedded object. The layout information. The explicit content type, if any. Initializes a new instance of the class with the specified document, path, link flag, layout, and content type. The document model. The path to the embedded or linked object. Indicates whether the object should be linked () or embedded (). The layout information. The explicit content type, if any. Sets the link for the OLE object. The link to the external object. The range within the linked object, if any. The explicit content type, if any. Thrown if is null. Sets the data for the OLE object from the specified file path. The file path containing the embedded object data. The explicit content type, if any. Thrown if is null. Thrown if the file at does not exist. Sets the data for the OLE object from the specified stream. The stream containing the embedded object data. The source path of the embedded object. The explicit content type, if any. Thrown if or is null. Specifies the update behavior for an OLE linked object. The OLE linked object is always updated automatically. The OLE linked object is updated only when explicitly called. Provides data for events that track the progress of an operation, such as loading and saving of a document. Cancels the operation that reported this progress change. Represents a page layout orientation. Specifies that pages in a shall be printed in portrait mode. Specifies that pages in a shall be printed in landscape mode, which prints the page contents with a 90 degree rotation with respect to the normal page orientation. Specifies the outline level. Specifies that there is no outline level specifically applied to this paragraph (bottommost level). Outline level 1 (topmost level). Outline level 2. Outline level 3. Outline level 4. Outline level 5. Outline level 6. Outline level 7. Outline level 8. Outline level 9. Represents the space between the element border and the element content. Represents no padding or zero padding. Initializes a new instance of the struct with specified left, top, right and bottom padding. The left padding. The top padding. The right padding. The bottom padding. Initializes a new instance of the struct with specified left/right and top/bottom padding. The left/right padding. The top/bottom padding. Initializes a new instance of the struct with specified left/top/right/bottom padding. The left/top/right/bottom padding. Initializes a new instance of the struct with specified left, top, right and bottom padding in specified measurement unit. The left padding. The top padding. The right padding. The bottom padding. The measurement unit used to specify padding. Initializes a new instance of the struct with specified left/right and top/bottom padding in specified measurement unit. The left/right padding. The top/bottom padding. The measurement unit used to specify padding. Initializes a new instance of the struct with specified left/top/right/bottom padding in specified measurement unit. The left/top/right/bottom padding. The measurement unit used to specify padding. Gets the left padding in points. The left padding in points. Gets the top padding in points. The top padding in points. Gets the right padding in points. The right padding in points. Gets the bottom padding in points. The bottom padding in points. Determines whether the   is equal to this instance. The other padding to compare with this padding instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this padding instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first padding. The second padding. if and paddings are equal; otherwise, . Determines whether and  s are not equal. The first padding. The second padding. if and paddings are not equal; otherwise, . Represents a set of page borders. class is used to set borders for element. supports borders. Gets or sets a value indicating whether to apply page borders to only the first page of the section. Default value: . to apply page borders to only the first page of the section; otherwise, . Gets or sets a value indicating whether to apply page borders to all pages of the section, except the first page. Default value: . to apply page borders to all pages of the section, except the first page; otherwise, . Gets or sets a value indicating whether the property on each page shall be interpreted as the distance from the edge of the page or as the distance from the that shall be left before the page border. Default value: . to interpret the property on each page as the distance from the edge of the page that shall be left before the page border; otherwise, to interpret it as the distance from the that shall be left before the page border. Gets or sets a value indicating whether paragraph borders specified using the property and table borders using the property shall be adjusted to align with extents of the page border defined using the property if the spacing between these borders is less than or equal to 10.5 points (one character width) or less from the page border. value of this property shall ensure there are no gaps of one character width or less between adjoining page and paragraph/table borders, as borders which are perfectly aligning shall not be displayed in favor of the intervening page border. If value of this property is , then borders shall not be automatically adjusted to prevent gaps of less than one character width. If the page border is not measured from the text extents ( is ), then this property is ignored. This property is stored in , therefore it applies to the entire document. Supported only in DOCX and DOC formats. This value is currently ignored when exporting a document to PDF, XPS, or image formats. Default value: . if paragraph borders specified using the property and table borders using the property shall be adjusted to align with extents of the page border defined using the property if the spacing between these borders is less than or equal to 10.5 points (one character width) or less from the page border; otherwise, . cannot be accessed from this either because has been removed from the parent or because has been removed from the parent . Gets or sets a value indicating whether the page border is positioned above or below intersecting texts and objects in this document. Default value: . to render the page border above any text or object which intersects it - effectively placing it at the highest z-order on the page.; otherwise, to render the page border beneath any text or object which intersects it - effectively placing it at the lowest z-order on the page. Gets or sets a value indicating whether the document’s page border specified using the property should surround contents of the header. If the page border is not measured from the text extents ( is ), then this property is ignored. This property is stored in , therefore it applies to the entire document. Default value: . if the document’s page border specified using the property should surround contents of the header; otherwise, . cannot be accessed from this either because has been removed from the parent or because has been removed from the parent . Gets or sets a value indicating whether the document’s page border specified using the property should surround contents of the footer. If the page border is not measured from the text extents ( is ), then this property is ignored. This property is stored in , therefore it applies to the entire document. Default value: . if the document’s page border specified using the property should surround contents of the footer; otherwise, . cannot be accessed from this either because has been removed from the parent or because has been removed from the parent . Represents page margins. Initializes a new instance of the class. Gets or sets the top margin (in points). Default value for this property is 70.85 points (0.98 inch). The top margin. Gets or sets the bottom margin (in points). Default value for this property is 70.85 points (0.98 inch). The bottom margin. Gets or sets the left margin (in points). Default value for this property is 70.85 points (0.98 inch). The left margin. Gets or sets the right margin (in points). Default value for this property is 70.85 points (0.98 inch). The right margin. Gets or sets the gutter margin (in points). The gutter margin. Gets or sets the header margin (in points). Default value for this property is 35.4 points (0.49 inch). The header margin. Gets or sets the footer margin (in points). Default value for this property is 35.4 points (0.49 inch). The footer margin. Clones this instance. Cloned . Represents the page setup properties of a . For more information, see page setup example. Gets or sets the type of section start. The type of section start. Gets or sets whether the direction of the section is right-to-left. Default value is . if the direction of the section is right-to-left; otherwise, . Gets or sets the number style for the page number. Number style for the page number. Gets or sets the vertical alignment of text on each page in the section. Supported only in DOCX format. The vertical alignment of the text in the section's pages. Initializes a new instance of the class. Gets or sets the width of the page (in points). The width of the page. Gets or sets the height of the page (in points). The height of the page. Gets or sets the type of the paper for the page. Default value for this property is . This member is supported in printing. GemBox.Document uses enhanced printing services provided with Windows Presentation Foundation (WPF). All pages of a specific will be printed with settings from of that section. Internally, WPF printing uses PrintTicket class to specify page printing settings and value of this member is applied to appropriate member of PrintTicket instance which is used to print all pages of a section with this print options member. PrintTicket instance which is used to print every page of a section is constructed in following order: Based on stream specified in constructor (base print ticket). Appropriate base print ticket members are set based on instance members values. Base print ticket is cloned for each section, clone's appropriate members are set based on instance of that section and clone is used to print all pages of that section. Printing settings which do not exist in nor in can be specified on base print ticket (which stream is passed to constructor). The type of the paper. Gets or sets the page orientation. Changing of property swaps values of and properties. This member is supported in printing. GemBox.Document uses enhanced printing services provided with Windows Presentation Foundation (WPF). All pages of a specific will be printed with settings from of that section. Internally, WPF printing uses PrintTicket class to specify page printing settings and value of this member is applied to appropriate member of PrintTicket instance which is used to print all pages of a section with this print options member. PrintTicket instance which is used to print every page of a section is constructed in following order: Based on stream specified in constructor (base print ticket). Appropriate base print ticket members are set based on instance members values. Base print ticket is cloned for each section, clone's appropriate members are set based on instance of that section and clone is used to print all pages of that section. Printing settings which do not exist in nor in can be specified on base print ticket (which stream is passed to constructor). The page orientation. Gets or sets the page margins. The page margins. Gets the page borders. The page borders. Gets or sets the line number distance from text (in points). Set to 0 for automatic distance (Auto). The line number distance from text. Gets or sets the line number restart setting. The line number restart setting. Gets or sets the line starting number. The line starting number. Gets or sets the line number increments to be displayed. Although each line has an associated line number, only lines which are an even multiple of this value shall be displayed. The line number increments to be displayed in the current section. Gets or sets the text columns. The text columns. Gets or sets the number that appears on the first page of the section. Specifies the page number that appears on the first page of the section. If this value is omitted, numbering will continue from the highest page number in the previous section. The page starting number. Gets or sets the background color for all pages of the parent section. If page color is not set or is set to , it will be inherited from previous section. If page color is not set for the first section, then it defaults to . DOCX format supports only single page color for an entire document, so page color of the first section will be used for an entire document. Page colors of the subsequent sections won't be stored into DOCX format. The background color for all pages of the parent section. Gets or sets the number of characters per line in the document grid. Gets or sets the number of lines per page in the document grid. Gets or sets the grid mode for the section. Clones this instance. Cloned . Specifies vertical alignment of text on each page in the section. Top vertical alignment. Center vertical alignment. Justified vertical alignment. Bottom vertical alignment. Represents options used to specify which parts of the document to update while paginating it and which pages of the document should be returned in the paginator. Gets or sets a value indicating whether to update table column widths while paginating the document. will be set to a value calculated while paginating the document for each column in a table. to update table column widths while paginating the document; otherwise, . Gets or sets a value indicating whether to update table cell widths while paginating the document. will be set to a value calculated while paginating the document for each cell in a table. to update table cell widths while paginating the document; otherwise, . Gets or sets a value indicating whether to update table width while paginating the document. will be set to a value calculated while paginating the document for each table in the document. to update table width while paginating the document; otherwise, . Gets or sets a value indicating whether to update fields while paginating the document. will be reset while paginating the document for each supported field in the document. Currently supported fields are: , , , , , and . to update fields while paginating the document; otherwise, . If field is contained in header or footer, then its result will be equal to result visible on the last page which contains that header or footer. Gets or sets a value indicating whether to trim excess table cell spans while paginating the document. For example, table with two rows (row 1: cell[column span = 2], cell[column span = 2]) (row 2: cell[column span = 4]) will be trimmed to (row 1: cell[column span = 1], cell[column span = 1]) (row 2: cell[column span = 2]). to trim excess table cell spans while paginating the document; otherwise, . Gets or sets a value indicating whether to update text box heights while paginating the document. ... will be set to a value calculated while paginating the document for each text box in a document. to update text box heights while paginating the document; otherwise, . Gets or sets the zero-based page number that should be returned as the first page of the paginator. The zero-based page number that should be returned as the first page of the paginator. Even if this property is set, the whole document needs to be first paginated. This property only narrows down the returned paginator. Therefore, other properties in this class have effect on the whole document. Gets or sets the number of pages that should be contained in the paginator. The number of pages that should be contained in the paginator. The default value is (all pages). Even if this property is set, the whole document needs to be first paginated. This property only narrows down the returned paginator. Therefore, other properties in this class have effect on the whole document. Gets or sets the font-related settings used when paginating the document. If this property is , then static members of the are used to resolve font-related settings. The font-related settings used when paginating the document. Gets or sets a value indicating whether to do text layout using advanced text formatting implementation such as those from Windows Presentation Foundation (WPF) or HarfBuzz text-shaping engine, or to use the default primitive implementation. Default value is for improved performance and stability of the output because advanced text formatting is required only for complex scripts or advanced typography features. to do text layout using advanced text formatting implementation; otherwise to use the default primitive implementation. Occurs when progress of paginating a document has changed. Initializes a new instance of the class. Specifies the paper type. Custom paper type. Letter (8.5 inch X 11 inch). Legal (8.5 inch X 14 inch). Executive (7.25 inch X 10.5 inch). A3 (11.69 inch X 16.54 inch). A4 (8.27 inch X 11.69 inch). A5 (5.83 inch X 8.27 inch). B4 (JIS, 10.12 inch X 14.33 inch). 11x17 (11 inch X 17 inch). Envelope DL (4.33 inch X 8.66 inch). Envelope C5 (6.38 inch X 9.02 inch). B5 (ISO, 6.93 inch X 9.84 inch). A2 (16.54 inch X 23.39 inch). A6 (4.13 inch X 5.83 inch). Represents a paragraph of content in the document. is one of the main document building blocks. It can be contained under a , , , or . is a content element that contains derived elements in its Paragraph.Inlines property. For more information, see content model. can be formatted using the Paragraph.ParagraphFormat property, and it can also be formatted to be used as a part of the list using the Paragraph.ListFormat property. For more information about paragraph formatting, see paragraph formatting example. GemBox.Document Content Model Initializes a new instance of the class. The owner document. Initializes a new instance of the class with specified text. The owner document. The paragraph text. Initializes a new instance of the class with specified inlines. The owner document. The paragraph content. Initializes a new instance of the class with specified inlines. The owner document. The paragraph content. Gets the 's inlines. The 's inlines. All derived elements are supported in this collection. GemBox.Document Content Model Gets or sets the paragraph format. The paragraph format. For more information about paragraph formatting, see paragraph formatting example. Gets or sets the list format. The list format. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets or sets the character format for the paragraph mark. The character format for the paragraph mark. Gets the list item or if paragraph doesn't have list item. The list item or if paragraph doesn't have list item. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets or sets the revision information for the paragraph. The revision information for the paragraph. If the revision is of the type it means that this paragraph and the following paragraph were a single paragraph before applying this revision. If the revision is of the type it means that this paragraph and the following paragraph were separate paragraphs but they were joined after applying this revision. The revision is internally stored as a member of . Using set property on overrides this revision. Gets or sets the revision of the character format for the paragraph mark. This property contains the format which was applied before the revision. The revision of the character format for the paragraph mark. The revision is internally stored as a member of . Using set property on overrides this revision. Gets or sets the revision of the format of this paragraph. This property contains the format which was applied to this paragraph before the revision. The revision of the format of this paragraph. The revision is internally stored as a member of . Using set property on overrides this revision. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a set of paragraph formatting properties which shall be applied to the contents of the parent paragraph. GemBox.Document supports a variety of paragraph formatting options like alignment, borders, spacing, indentation, tabs and many others. can be set on: element; style;DocumentModel.DefaultParagraphFormat property.For more information about properties, see paragraph formatting example. GemBox.Document Formats and Styles Initializes a new instance of the class. Gets or sets the style. The style. Gets or sets the text alignment for the paragraph. The text alignment for the paragraph. If or are , will be rendered as and will be rendered as . Gets or sets the outline level. The outline level. Gets or sets the left indentation (in points) for the paragraph. The left indentation in points. Setting this property will also set the LeftIndentationChars and SpecialIndentationChars properties to . Gets or sets the left indentation (in chars) for the paragraph. Supported only in DOCX format. The left indentation in chars. This property has precedence over the LeftIndentation property when it is specified. Gets or sets the right indentation (in points) for the paragraph. The right indentation in points. Setting this property will also set the RightIndentationChars property to . Gets or sets the right indentation (in chars) for the paragraph. Supported only in DOCX format. The right indentation in chars. This property has precedence over the RightIndentation property when it is specified. Gets or sets the special indentation for the paragraph. The special indentation in points. This values is positive for hanging indentation and negative for first-line indentation. Setting this property will also set the LeftIndentationChars and SpecialIndentationChars properties to . Gets or sets the special indentation (in chars) for the paragraph. Supported only in DOCX format. The special indentation in chars. This values is positive for hanging indentation and negative for first-line indentation. This property has precedence over the LeftIndentation property when it is specified. Gets or sets whether the paragraph indents should be interpreted as mirrored indents. if paragraph indents should be interpreted as mirrored indents; otherwise, . When this property is then the left indent shall become the inside indent and the right indent shall become the outside indent. Gets or sets the amount of spacing (in points) before the paragraph. The space before. Setting this property will also set the SpaceBeforeLines property to . Gets or sets the amount of spacing (in lines) before the paragraph. Supported only in DOCX format. The space before. This property has precedence over the SpaceBefore property in case it is specified. Gets or sets a value indicating whether automatic spacing is applied before the paragraph. true if automatic spacing is used before the paragraph; otherwise, false. Gets or sets the amount of spacing (in points) after the paragraph. The space after. Setting this property will also set the SpaceAfterLines property to . Gets or sets the amount of spacing (in lines) after the paragraph. Supported only in DOCX format. The space after. This property has precedence over the SpaceAfter property in case it is specified. Gets or sets a value indicating whether automatic spacing is applied after the paragraph. true if automatic spacing is used after the paragraph; otherwise, false. Gets or sets the line spacing. The line spacing. If LineSpacingRule is Multiple then this value is in the number of lines, otherwise it is in the points. Gets or sets the line spacing rule. The line spacing rule. When true, spacing between paragraphs with the same style will be ignored. if spacing between paragraphs with the same style will be ignored; otherwise, . When true, the paragraph is on the same page as the following paragraph whenever possible. when keep with next paragraph; otherwise, . When true, all lines for this paragraph are maintained on a single page whenever possible. if all lines for this paragraph are maintained on a single page; otherwise, . When true, this paragraph is rendered on the start of a new page in the document. if page break needs to be added before paragraph; otherwise, . When true, this will prevent a single line of the paragraph from being displayed on a separate page from the remaining content. if single line will be prevented from displaying on a separate page from the remaining content; otherwise, . When true, this is a right-to-left paragraph. if this is right-to-left paragraph; otherwise, . Gets or sets the paragraph background color. The background color. Gets or sets a value indicating whether the line numbers should be suppressed for the paragraph. , if line numbers should be suppressed; otherwise, . Gets or sets a value indicating whether to break text which exceeds the text extents of a line by moving the word to the new line or breaking the word on the character level. , to break text on the word level; to break text on the character level. Gets or sets a value indicating whether inter-character spacing shall automatically be adjusted between regions of Latin text and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. if inter-character spacing shall automatically be adjusted between regions of Latin text and regions of East Asian text in the current paragraph; otherwise, . Gets or sets a value indicating whether inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph. These regions shall be determined by the Unicode character values of the text content within the paragraph. if inter-character spacing shall automatically be adjusted between regions of numbers and regions of East Asian text in the current paragraph; otherwise, . Gets the paragraph borders. The paragraph borders. Gets the s collection. The s collection. Creating customized tabs in a document is accomplished with structure that enables you to define tab position, tab leader character and surrounding text alignment. s should be inserted into ParagraphFormat.Tabs collection to be used in a . Tabs are inserted into a document content with elements that have SpecialCharacter.CharacterType property equal to . Values and are currently not supported in PDF, XPS and image file formats. Determines whether the specified is equal to this instance. The to compare with this paragraph format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first paragraph format. The second paragraph format. if and paragraph formats are equal; otherwise, . Determines whether and  s are not equal. The first paragraph format. The second paragraph format. if and paragraph formats are not equal; otherwise, . Clones this instance. Cloned . Clones this instance. If , the values to be cloned will be fetched from this object's resolved values. This means that even if a property was never explicitly set, this method will look into this format style or in the document's default formats to resolve the values and explicitly set them in the cloned object. Cloned . Represents a style which can be applied to one or more s within a document content. Styles provide a way to format your document in a consistent way so when you change your formatting options on a style, all document elements referencing that style will be changed. To apply a to a , set it to a ParagraphFormat.Style property on a Paragraph.ParagraphFormat. For an example how to apply to a , see styles example. GemBox.Document Formats and Styles Initializes a new instance of the class. The style name. Gets or sets the paragraph format which shall be applied to the referencing . The paragraph format which shall be applied to the referencing . For more information about paragraph formatting, see paragraph formatting example. Gets or sets the list format. The list format. List (for example, ordered - with numbers, or unordered - with bullets) appearance in GemBox.Document is defined through class that is set on 's property or 's property. is different from other formats ( and ) because it doesn't directly contain any formatting properties. It contains a reference to a which exposes s for every list (indentation) level through its property. s contain direct formatting properties that affect the appearance of the list. Every contains exactly 9 s, one for each possible list (indentation) level. 's list (indentation) level can be adjusted with ListFormat.ListLevelNumber property. 's list-related formatting will then be collected from the instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber. This can also be retrieved from the ListFormat.ListLevelFormat property. retrieved from the ListFormat.ListLevelFormat property can be additionally modified to enable overriding property values of instance contained in the ListStyle.ListLevelFormats at the position ListFormat.ListLevelNumber on a or basis. To create a list in a document, first instance has to be created from one of the predefined list style types specified with enumeration. After that, can be created with a specified and assigned to a 's property. For a complete example, see Lists example. If is not referenced from anywhere in the document (from any or , then it won't be saved to a Word Document (DOCX) file, unless it is added to collection. 's list content, which prefixes paragraph content, is represented by type. s are not permanently stored in model nor they are written to file formats which fully support , instead they are recreated each time method is called. If document content or formatting is changed, then method should be called again to retrieve the latest list items. For convenience, after calling method, can also be retrieved from property. After calling on instance retrieved by calling on instance returned from method, paragraph's property will be even if paragraph's is . This enables easy iteration over s returned from method by using foreach statement and removing all references to s after the iteration is finished. Gets or sets the character format. The character format. Gets or sets the style on which this style is based. The base style. Gets or sets the style that will be assigned automatically to following paragraph. The next paragraph style. This property is simply written to Word file and has no effect on the behavior of this library. Options used for creating PDF bookmarks (outlines) when saving a document to a PDF file. Do not create PDF bookmarks. Create PDF bookmarks (outlines) using heading paragraphs. Create PDF bookmarks (outlines) using document bookmarks ( elements). Represents levels of conformance for PDF documents. No conformance. PDF/A-1 is based on PDF version 1.4, which first appeared in 2001. All resources (images, graphics, typographic characters) must be embedded within the PDF/A document itself. A PDF/A file requires precise, platform-independent color data using ICC profiles, and XMP for the document metadata. Transparent elements, some forms of compression (LZW, JPEG2000), PDF layers, and certain actions or JavaScript are forbidden. A PDF/A file must not be password-protected. PDF/A-1 expressly supports embedded digital signatures and the use of hyperlinks. Level A (Accessible) meets all requirements for the standard, including the logical structure of the document and its correct reading order. Text must be extractable and the logical structure must match the natural reading order. Fonts used must meet stringent requirements. This PDF/A level can usually only be met by converting born-digital documents. PDF/A-1 is based on PDF version 1.4, which first appeared in 2001. All resources (images, graphics, typographic characters) must be embedded within the PDF/A document itself. A PDF/A file requires precise, platform-independent color data using ICC profiles, and XMP for the document metadata. Transparent elements, some forms of compression (LZW, JPEG2000), PDF layers, and certain actions or JavaScript are forbidden. A PDF/A file must not be password-protected. PDF/A-1 expressly supports embedded digital signatures and the use of hyperlinks. Level B (Basic) guarantees that the content of the document can be unambiguously reproduced. Level B files are easier to create than Level A, but Level B does not guarantee 100% text extraction or searchability. It does not necessarily mean that the content can be reused without any problems. Scanned paper documents can usually be converted to PDF/A Conformance Level B without any extra work. PDF/A-2 was published in 2011 as "ISO 19005-2". Based on PDF version 1.7, which has since been standardized as "ISO 32000-1", it makes use of this version’s new features. This means PDF/A-2 allows JPEG2000 compression, transparent elements and PDF layers. PDF/A-2 also allows you to embed OpenType fonts and supports PAdES(PDF Advanced Electronic Signatures)-compliant digital signatures. One particularly important innovation is the "container" function: PDF/A files can be embedded within a PDF/A-2 document. Level A (Accessible) meets all requirements for the standard, including the logical structure of the document and its correct reading order. Text must be extractable and the logical structure must match the natural reading order. Fonts used must meet stringent requirements. This PDF/A level can usually only be met by converting born-digital documents. PDF/A-2 was published in 2011 as "ISO 19005-2". Based on PDF version 1.7, which has since been standardized as "ISO 32000-1", it makes use of this version’s new features. This means PDF/A-2 allows JPEG2000 compression, transparent elements and PDF layers. PDF/A-2 also allows you to embed OpenType fonts and supports PAdES(PDF Advanced Electronic Signatures)-compliant digital signatures. One particularly important innovation is the "container" function: PDF/A files can be embedded within a PDF/A-2 document. Level B (Basic) guarantees that the content of the document can be unambiguously reproduced. Level B files are easier to create than Level A, but Level B does not guarantee 100% text extraction or searchability. It does not necessarily mean that the content can be reused without any problems. Scanned paper documents can usually be converted to PDF/A Conformance Level B without any extra work. PDF/A-2 was published in 2011 as "ISO 19005-2". Based on PDF version 1.7, which has since been standardized as "ISO 32000-1", it makes use of this version’s new features. This means PDF/A-2 allows JPEG2000 compression, transparent elements and PDF layers. PDF/A-2 also allows you to embed OpenType fonts and supports PAdES(PDF Advanced Electronic Signatures)-compliant digital signatures. One particularly important innovation is the "container" function: PDF/A files can be embedded within a PDF/A-2 document. Level U (Unicode) was introduced along with PDF/A-2. It expands Conformance Level B to specify that all text can be mapped to standard Unicode character codes. PDF/A-3 has been available since October 2012. A PDF/A-3 document allows you to embed any file format desired – not just PDF/A documents. For example, a PDF/A-3 file can contain the original file from which it was generated. The PDF/A standard does not regulate the suitability of these embedded files for archiving. Level A (Accessible) meets all requirements for the standard, including the logical structure of the document and its correct reading order. Text must be extractable and the logical structure must match the natural reading order. Fonts used must meet stringent requirements. This PDF/A level can usually only be met by converting born-digital documents. PDF/A-3 has been available since October 2012. A PDF/A-3 document allows you to embed any file format desired – not just PDF/A documents. For example, a PDF/A-3 file can contain the original file from which it was generated. The PDF/A standard does not regulate the suitability of these embedded files for archiving. Level B (Basic) guarantees that the content of the document can be unambiguously reproduced. Level B files are easier to create than Level A, but Level B does not guarantee 100% text extraction or searchability. It does not necessarily mean that the content can be reused without any problems. Scanned paper documents can usually be converted to PDF/A Conformance Level B without any extra work. PDF/A-3 has been available since October 2012. A PDF/A-3 document allows you to embed any file format desired – not just PDF/A documents. For example, a PDF/A-3 file can contain the original file from which it was generated. The PDF/A standard does not regulate the suitability of these embedded files for archiving. Level U (Unicode) was introduced along with PDF/A-2. It expands Conformance Level B to specify that all text can be mapped to standard Unicode character codes. Represents a class that stores details for signing a document saved to a Portable Document Format (PDF) with a digital signature. Document will be digitally signed when saved to a PDF if , or is specified, if instance is created with method or if Sign(Stream) method is overridden, otherwise it will be saved but not digitally signed. If your project doesn't target Windows platform, to use , make sure your project references NuGet package System.Security.Cryptography.Pkcs. PDF digital signature examples Gets or sets a value indicating whether the signature is PDF Advanced Electronic Signature (PAdES). if the signature is PDF Advanced Electronic Signature (PAdES); otherwise, . PAdES baseline signatures Extended PAdES signature profiles Gets or sets the CPU host name or physical location of the signing. The CPU host name or physical location of the signing. Gets or sets the contact information. Information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number. Initializes a new instance of the class. Initializes a new instance of the class from the specified signer. A delegate that returns the format of the signature content that the signer produces. A delegate that returns the estimated length of the signature content (in bytes) that should be large enough to contain the entire data returned by the delegate. A delegate called when saving the PDF file that takes the PDF file stream (without signature's Contents entry) as an input and returns the signature that will be set as the value of the signature's Contents entry. A new instance of the class from the specified signer. PAdES signature (LTV enabled) example Gets the estimated signature length. The estimated signature length. Returns the digital signature for the PDF file stream. The PDF file stream that will be digitally signed. The digital signature for the PDF file stream. Represents a class that stores loading options for Portable Document Format (PDF). For more information about PDF reading, see support level for reading PDF format. Support level for reading PDF format Read and Extract PDF Text in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Gets or sets the password to open protected / encrypted PDF document. The password to open protected / encrypted PDF document. Opening an encrypted PDF document with not specified or invalid password raises . If PDF document is not encrypted, then value of this property is simply ignored. For an example of reading and/or writing encrypted PDF file, see PDF encryption example.

Gets or sets the strategy that should be used when loading this document.

By default, the loading type is

The strategy that should be used when loading this document. Initializes a new instance of the class. Specifies possible strategies for loading PDF files. Loading that preserves logical structure.

When using this type of loading, the file will be loaded by trying to detect the logical structure of the document. This kind of file is easier to edit but can visually look different because it's not always possible to correctly detect the structure of a PDF.

For example, a PDF page with text in two columns could be a table with a single row and two cells or a section with two columns.

 High fidelity loading.

When using this type of loading, the file will be loaded with high fidelity which means it will look very similar to the PDF but it will not detect the logical structure of the document.

For example a text organized in rows and columns will not be interpreted as a table but each text will be absolutely positioned using text frames and text boxes.

 Defines operations that are allowed to a user on an encrypted PDF document. For more information about PDF encryption, see remarks. PDF Encryption in C# and VB.NET Disallows all operations. Allows printing. Allows high resolution printing. Allows changing the document. Allows copying the content. Allow accessibility software to use the document contents. If this is disabled, inserting, deleting or rotating pages, or creating bookmarks and thumbnails is prohibited. Allows adding or modifying text annotations, filling of interactive form fields (including signature fields). Allows all operations. Represents the version of the PDF specification to which the PDF document conforms. History and standardization of Portable Document Format The PDF document conforms to the PDF 1.0 specification released in 1993. The PDF document conforms to the PDF 1.1 specification released in 1994 and supported in Acrobat Reader 2.0. The PDF document conforms to the PDF 1.2 specification released in 1996 and supported in Acrobat Reader 3.0. The PDF document conforms to the PDF 1.3 specification released in 2000 and supported in Acrobat Reader 4.0. The PDF document conforms to the PDF 1.4 specification released in 2001 and supported in Acrobat Reader 5.0. The PDF document conforms to the PDF 1.5 specification released in 2003 and supported in Acrobat Reader 6.0. The PDF document conforms to the PDF 1.6 specification released in 2004 and supported in Acrobat Reader 7.0. The PDF document conforms to the PDF 1.7 specification released in 2006 and to the ISO 32000-1:2008 specification released in 2008 and supported in Acrobat Reader 8.0. The PDF document conforms to the ISO 32000-2:2017 specification released in 2017. Represents a picture file format. Unknown picture file format. Portable Network Graphics (PNG) file format. Joint Photographic Experts Group (JPEG) file format. Tagged Image File Format (TIFF). Graphics Interchange Format (GIF) Legacy native graphics format of Apple's 2D graphics library QuickDraw which is a core part of the classic Apple Macintosh operating system. Scalable Vector Graphics (SVG) file format. Enhanced Metafile Format (EMF) file format. Windows Metafile Format (EMF) file format. Represents the file format for an image contained in stream. Jpeg Gif Png Tiff Emf Wmf Svg Represents the picture watermark that appears behind the document content. Initializes a new instance of the picture watermark. The owner document. The picture that will represent this watermark. Gets or sets the picture that represents the watermark. The picture that represents the watermark. Gets or sets whether washout should be applied to the picture watermark The default value is true. True if washout should be applied, false otherwise. Scales the picture watermark to automatically fit into the page. The watermark has to be already assigned to a for this method to work. An enumeration of supported pixel formats when saving a to an image using an . Pixel format that is best suited for the particular operation. Bgr101010 is a sRGB format with 32 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 10 bits per pixel (BPP). Bgr24 is a sRGB format with 24 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 8 bits per pixel (BPP). Bgr32 is a sRGB format with 32 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 8 bits per pixel (BPP). Bgr555 is a sRGB format with 16 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 5 bits per pixel (BPP). Bgr565 is a sRGB format with 16 bits per pixel (BPP). Each color channel (blue, green, and red) is allocated 5, 6, and 5 bits per pixel (BPP) respectively. Bgra32 is a sRGB format with 32 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 8 bits per pixel (BPP). Black and white pixel format which displays one bit of data per pixel as either black or white. Cmyk32 pixel format which displays 32 bits per pixel (BPP) with each color channel (cyan, magenta, yellow, and black) allocated 8 bits per pixel (BPP). Gray16 pixel format which displays a 16 bits-per-pixel grayscale channel, allowing 65536 shades of gray. This format has a gamma of 1.0. Gray2 pixel format which displays a 2 bits-per-pixel grayscale channel, allowing 4 shades of gray. Gray32Float displays a 32 bits per pixel (BPP) grayscale channel, allowing over 4 billion shades of gray. This format has a gamma of 1.0. Gray4 pixel format which displays a 4 bits-per-pixel grayscale channel, allowing 16 shades of gray. Gray8 pixel format which displays an 8 bits-per-pixel grayscale channel, allowing 256 shades of gray. Pbgra32 is a sRGB format with 32 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 8 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. Prgba128Float is a ScRGB format with 128 bits per pixel (BPP). Each channel (red, green, blue, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0. Prgba64 is a sRGB format with 64 bits per pixel (BPP). Each channel (blue, green, red, and alpha) is allocated 32 bits per pixel (BPP). Each color channel is pre-multiplied by the alpha value. This format has a gamma of 1.0. Rgb128Float is a ScRGB format with 128 bits per pixel (BPP). Each color channel is allocated 32 BPP. This format has a gamma of 1.0. Rgb24 is a sRGB format with 24 bits per pixel (BPP). Each color channel (red, green, and blue) is allocated 8 bits per pixel (BPP). Rgb48 is a sRGB format with 48 bits per pixel (BPP). Each color channel (red, green, and blue) is allocated 16 bits per pixel (BPP). This format has a gamma of 1.0. Rgba128Float is a ScRGB format with 128 bits per pixel (BPP). Each color channel is allocated 32 bits per pixel (BPP). This format has a gamma of 1.0. Rgba64 is an sRGB format with 64 bits per pixel (BPP). Each channel (red, green, blue, and alpha) is allocated 16 bits per pixel (BPP). This format has a gamma of 1.0. Represents an element that is loaded from a file and is not directly supported by GemBox.Document API. This element can appear in document content only if file is loaded with the LoadOptions.PreserveUnsupportedFeatures property set to . For more information, see preservation article and preservation example. GemBox.Document Content Model Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Returns a string that represents the current object. A string that represents the current object. Indicates how to position two rectangles relative to each other. Center. Top. Bottom. Left. Right. Top Left. Top Right. Bottom Left. Bottom Right. Represents the relative space between the element border and the element content. Represents no padding or zero padding. Gets the left padding percentage. The left padding percentage. Value 0 represents 0% while value 1 represents 100%. Gets the top padding percentage. The top padding percentage. Value 0 represents 0% while value 1 represents 100%. Gets the right padding percentage. The right padding percentage. Value 0 represents 0% while value 1 represents 100%. Gets the bottom padding percentage. The bottom padding percentage. Value 0 represents 0% while value 1 represents 100%. Initializes a new instance of the struct with specified left, top, right and bottom padding percentage. The left padding percentage. The top padding percentage. The right padding percentage. The bottom padding percentage. Initializes a new instance of the struct with specified left/right and top/bottom padding percentage. The left/right padding percentage. The top/bottom padding percentage. Initializes a new instance of the struct with specified left/top/right/bottom padding percentage. The left/top/right/bottom padding percentage. Determines whether the   is equal to this instance. The other padding to compare with this padding instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this padding instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first padding. The second padding. if and paddings are equal; otherwise, . Determines whether and  s are not equal. The first padding. The second padding. if and paddings are not equal; otherwise, . Defines the supported rendering modes. Use either the default implementation, , , or for rendering, depending on the availability and supported features. Use Windows Presentation Foundation (WPF) for rendering. Use Skia (via SkiaSharp NuGet package) for rendering and HarfBuzz text-shaping engine for text formatting. Make sure your project also references the appropriate SkiaSharp.NativeAssets.* and HarfBuzzSharp.NativeAssets.* NuGet packages depending on the platform on which you are building/running your application. The slowest one, implemented fully in the managed code. Provides data for the event. The URI of the external resource in loaded document, you can use it to provide a different location for the current resource. The current resource data, you can use it to provide custom data. The type of the external resource. Represents the type of external resource. Image. Cascading Style Sheet. Represents a class that stores loading options for Rich Text (RTF) format. Initializes a new instance of the class. Gets or sets the encoding for the RTF file. The encoding for the RTF file. Value is set to . Represents options for saving to Rich Text (RTF) format. RTF supports inclusion of JPEG, PNG, EMF, WMF, Apple PICT, Windows bitmap and OS/2 Metafile picture types. Not all of these picture types are supported in all RTF readers. When a RTF document is opened in software that does not support the picture type of an inserted picture, such picture is not displayed at all. For better compatibility with some Microsoft applications (e.g. WordPad) two copies of the graphic are saved in the document. Graphics are saved in the applicable EMF, PNG, GIF, or JPEG format and are also converted to WMF (Windows Metafile) format. Property gets or sets the flag indicating whether to create a Windows Metafile (WMF) copy of the original picture when saving the instance. to create a Windows Metafile (WMF) copy of the original picture when saving the instance; otherwise, . Gets or sets the encoding for the RTF file. The encoding for the RTF file. Value is set to . Initializes a new instance of the class. Gets the content-type for RTF file format: application/rtf. The content-type for RTF file format. Represents a region of text with a common set of properties. is an element used to insert textual content to a document. Run.Text property holds a text contained in the instance. can be formatted directly using the Run.CharacterFormat property or, indirectly, using a class. For more information, see character formatting example. GemBox.Document Content Model Initializes a new instance of the class with empty . The owner document. Initializes a new instance of the class with specified text. The owner document. The text for this instance. Gets or sets the text of this instance. The text of this instance. Text should not contain special characters like '\n', '\r', '\t', '\v' and '\f'. If it does, will be thrown. To add line breaks, page breaks, column breaks and tabs, use element. Gets or sets the character format. The character format. This property is defined as direct formatting, since it is directly applied to the run and supersede any formatting from styles. If Run.Text is , then and its Run.CharacterFormat won't be saved to DOCX. In that case, if is the last or the only element in the parent , use Paragraph.CharacterFormatForParagraphMark of the parent paragraph to save character (font) formatting to DOCX. For more information about paragraph formatting, see character formatting example. Gets or sets the revision of the format of this run. This property contains the format which was applied to this run before the revision. The revision of the format of this run. The revision is internally stored as a member of . Using set property on overrides this revision. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a base class for saving options of various file formats. DocumentModel.Save methods Create and write to Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets the default saving options for Microsoft Word file format. Word file will be saved in format. The default saving options for Microsoft Word file format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for Portable Document Format (PDF). The default saving options for Portable Document Format (PDF). This property always returns a new instance of class initialized with default constructor. Gets the default saving options for XML Paper Specification (XPS) format. The default saving options for XML Paper Specification (XPS) format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for image file format. Image will be saved in format. The default saving options for image file format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for HyperText Markup Language (HTML) format. The default saving options for HyperText Markup Language (HTML) format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for Plain Text (TXT) format. The default saving options for Plain Text (TXT) format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for Rich Text (RTF) format. The default saving options for Rich Text (RTF) format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for XML file format. The default saving options for XML file format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for Open Document file format. The default saving options for Open Document file format. This property always returns a new instance of class initialized with default constructor. Gets the default saving options for Markdown file format. The default saving options for Markdown file format. This property always returns a new instance of class initialized with default constructor. Gets or sets the zero-based page number of the document's first page which should be saved. The zero-based page number of the document's first page which should be saved. Gets or sets the number of pages which should be saved. The number of pages which should be saved. The default value is (all pages). Gets the content-type for this specific file format as defined in the RFC 2616. The content-type for this specific file format. RFC 2616 Represents a group of s and other derived elements that have a specific set of properties used to define the pages on which the text will appear, as well as other section-level properties. elements are contained directly under the root element - and can be accessed with DocumentModel.Sections property. Except holding the main document content, through Section.Blocks property, can also contain s, that are repeated on a header or a footer of a pages showing the 's content. Page setup properties, like page layout and printing options, can be customized with a Section.PageSetup property. GemBox.Document Content Model Initializes a new instance of the class. The owner document. Initializes a new instance of the class. The owner document. The section items. Initializes a new instance of the class. The owner document. The section items. Gets the that contains this instance. The that contains this instance. Gets the parent of this instance. The parent of this instance. Gets the 's blocks. The 's blocks. Supports all derived elements: , and . GemBox.Document Content Model Gets the 's headers / footers. The 's headers / footers. Since class is , only supported element in this collection is . cannot contain multiple elements with equal HeaderFooter.HeaderFooterType. Following rules apply for headers / footers contained in a collection: / - header / footer will be applied to every page in a section. / - header / footer will be applied to only even pages in a section. Overrides / on even pages, if also contained in a collection. / - header / footer will be applied to only first page in a section. Overrides both / and / on first page, if also contained in a collection. GemBox.Document Content Model Gets or sets the page setup. The page setup. Gets the footnote settings. The footnote settings. can be configured using on a document level ( and ) or on a section level ( and . Document level settings are cloned when new is added to the . PDF format has the following limitations: Footnotes are always rendered on the same page as their references. Footnotes that don't fit on a single page are clipped. Note numbering setting is not supported. HTML and TXT formats have the following limitations: All footnotes and then endnotes are exported at the end of the document. Note numbering setting is not supported. Gets the endnote settings. The endnote settings. can be configured using on a document level ( and ) or on a section level ( and . Document level settings are cloned when new is added to the . PDF format has the following limitations: Footnotes are always rendered on the same page as their references. Footnotes that don't fit on a single page are clipped. Note numbering setting is not supported. HTML and TXT formats have the following limitations: All footnotes and then endnotes are exported at the end of the document. Note numbering setting is not supported. When true, the will be protected when the document is protected for forms. When a section is protected for forms, you can select and modify text only in form fields. if the will be protected when the document is protected for forms; otherwise, . Gets or sets the revision information for the section properties. The revision information for the section properties. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a collection of elements. Used as a container for a DocumentModel.Sections property. GemBox.Document Content Model Represents a type of section start that is used in defining . Section will start of the new page. Section will start on the same page as previous section. Section will start on the even-numbered page. Section will start on the odd-numbered page. Represents an X.509 certificate sent to others so that they can verify your digital signature with a public key contained in the certificate. GemBox.Document doesn't use class to represent a certificate because creates a file that holds the certificate with the public key (in various locations on a hard drive) and on some operating systems and platforms that file is not deleted unless method is called. Another reason why GemBox.Document abstracts a certificate with a class instead of using directly is to enable different implementations of a certificate. For example, either implementation from .NET or Org.BouncyCastle.X509.X509Certificate implementation from Bouncy Castle could be used. RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile Initializes a new instance of the class from a file with the specified file name. The name of a certificate file. is . Initializes a new instance of the class from the specified source. The certificate source is an instance of a . The certificate source that is an instance of a . The parameter is not an instance of a . Gets the subject distinguished name from the certificate. The subject distinguished name from the certificate. Gets the value of a Common Name attribute from 's distinguished name. The value of a Common Name attribute from 's distinguished name. Gets the copy of raw data of a . The copy of raw data of the as a byte array. Determines whether the specified is equal to this instance. The to compare with this instance. if the specified is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this instance. if the specified is equal to this instance; otherwise, . Returns a hash code for this instance. A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents a commitment type when signing the document. No commitment type Created this document Approved this document Created and approved this document Represents a single border around a document element. defines a border line pattern style, color and width for a single border around an element. is only directly used in a CharacterFormat.Border property, otherwise it is contained in a ParagraphFormat.Borders, TableFormat.Borders or TableCellFormat.Borders properties. Value that represents that there is no border. Initializes a new instance of the struct. The border style. The border color. The border width in points. Gets the border style. The border style. Gets the border color. The border color. Gets the border width in points. The border width in points. Gets the spacing offset (in points) that shall be used to place this border on the parent object. Supported in DOCX and DOC formats. Supported in PDF format on and paragraph . When a document has a page border that is relative to the page edges (using a value of in the on ), it shall specify the distance between the edge of the page and the beginning of this border in points. When a document has a page border that is relative to the text extents (using a value of in the on ), it shall specify the distance between the margins of the page and the beginning of this border in points. The spacing offset that shall be used to place this border on the parent object. This value is currently ignored when exporting a document to PDF, XPS, or image formats if specified on a non-page or a non-paragraph border. Determines whether the   is equal to this instance. The other border to compare with this border instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this border instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first border. The second border. if and borders are equal; otherwise, . Determines whether and  s are not equal. The first border. The second border. if and borders are not equal; otherwise, . Represents single border type. Left border. Top border. Right border. Bottom border. Inside horizontal border. Inside vertical border. Diagonal down border (from top-left to bottom-right). Diagonal up border (from bottom-left to top-right). A structure used to describe the size of an object. Gets the width in points. The width in points. Gets the height in points. The height in points. Initializes a new instance of the struct using the measurement unit. The width in points. The height in points. Initializes a new instance of the struct using the specified measurement unit. The width in units specified by parameter. The height in units specified by parameter. The measurement unit for and . Determines whether the   is equal to this instance. The other size to compare with this size instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this size instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first size. The second size. if and size are equal; otherwise, . Determines whether and  s are not equal. The first size. The second size. if and size are not equal; otherwise, . Represents a character, such as break or tab, which shall be placed at the current location in the document content. is an element. To specify which special character you want to insert, use SpecialCharacter.CharacterType property. For more information about breaks, see breaks example. For more information about tabs, see . GemBox.Document Content Model Gets or sets the character type. The character type. Initializes a new instance of the class. The owner document. The character type. Gets or sets the character format. The character format. This property is defined as direct formatting, since it is directly applied to the and supersedes any formatting from styles. For more information about character formatting, see character formatting example. Gets or sets the revision of the format of this SpecialCharacter. This property contains the format which was applied to this SpecialCharacter before the revision. The revision of the format of this SpecialCharacter. The revision is internally stored as a member of . Using set property on overrides this revision. Clones this instance. Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents the type of the . Specifies that the document content shall restart on the next line. Specifies that the document content shall restart on the next page. Specifies that the document content shall restart on the next column available on the current page. If the current section is not divided into columns, or the column break occurs in the last column on the current page when displayed, then the restart location for text shall be the next page in the document. Specifies that the position of the current line of text will advance to the next location which is further along than the starting location of the tab or to nearest multiple of the default tab stop width. Specifies that the current position holds the reference to footnote or endnote element. Specifies the location of footnote or endnote area separator. Specifies the location of footnote or endnote area continuation separator. Specifies that a carriage return shall be placed at the current location in the run content. Specifies that the document content shall restart on the next line and the content should be moved down until the text can span the full width of the line (i.e. it doesn't have any floating object on the left or right). Represents a style. is a base class for , and . All document styles are contained in a DocumentModel.Styles collection. To create one of the predefined styles, use Style.CreateStyle(StyleTemplateType,DocumentModel) static method. For more information see formats and styles. GemBox.Document Formats and Styles Gets the owner document. The owner document. Gets or sets the style on which this style is based. The base style. Gets the type of the style. The type of the style. Gets or sets the name of the style. The name. Creates one of the predefined styles. Type that determines predefined style. The owner document. Predefined style. Styles example GemBox.Document Formats and Styles Returns a that represents this instance. A that represents this instance. This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions). Represents a collection of s. Used as a container for a DocumentModel.Styles property. GemBox.Document Formats and Styles Adds a instance to the . The instance. Gets the that corresponds to given . Gets the that corresponds to given . If doesn't contain correspondent style, then new style will be added and returned. The instance. that corresponds to given . Gets the at the specified index. The at the specified index. The zero-based index of the to get. The at the specified index. Gets the with the specified style name. The with the specified style name. Name of the style. The with the specified style name. Style with the specified name is not contained in the collection. Gets the number of s contained in the . The number of s contained in the . Determines the index of a specific instance in the . The instance to locate in the . The index of if found in the collection; otherwise, -1. Determines whether the contains a specific instance. The instance to locate in the . if is found in the ; otherwise, . Determines whether the contains a instance with specific name. Name of the to locate in the . if instance with specific name is found in the ; otherwise, . Removes the specific instance from the . The instance to remove from the . if the was found and removed from the ; otherwise, . The specific is used by one or more document elements. Returns an enumerator that iterates through the . A IEnumerator<Style> that can be used to iterate through the . Type that determines predefined style. Used in and methods to create an instance of a predefined style. 'Normal' . 'Heading 1' . 'Heading 2' . 'Heading 3' . 'Heading 4' . 'Heading 5' . 'Heading 6' . 'Heading 7' . 'Heading 8' . 'Heading 9' . 'Title' . 'Default paragraph font' . 'Subtitle' . 'Strong' . 'Emphasis' . 'No spacing' . 'Quote' . 'Intense quote' . 'List paragraph' . 'Subtle emphasis' . 'Intense emphasis' . 'Subtle reference' . 'Intense reference' . 'Book title' . 'Placeholder Text' . 'Normal' (MS Word 2010). 'Table grid' (MS Word 2010). 'Light Shading' (MS Word 2010). 'Light Shading Accent 1' (MS Word 2010). 'Light Shading Accent 2' (MS Word 2010). 'Light Shading Accent 3' (MS Word 2010). 'Light Shading Accent 4' (MS Word 2010). 'Light Shading Accent 5' (MS Word 2010). 'Light Shading Accent 6' (MS Word 2010). 'Light List' (MS Word 2010). 'Light List Accent 1' (MS Word 2010). 'Light List Accent 2' (MS Word 2010). 'Light List Accent 3' (MS Word 2010). 'Light List Accent 4' (MS Word 2010). 'Light List Accent 5' (MS Word 2010). 'Light List Accent 6' (MS Word 2010). 'Light Grid' (MS Word 2010). 'Light Grid Accent 1' (MS Word 2010). 'Light Grid Accent 2' (MS Word 2010). 'Light Grid Accent 3' (MS Word 2010). 'Light Grid Accent 4' (MS Word 2010). 'Light Grid Accent 5' (MS Word 2010). 'Light Grid Accent 6' (MS Word 2010). 'Colorful Grid' (MS Word 2010). 'Colorful Grid Accent 1' (MS Word 2010). 'Colorful Grid Accent 2' (MS Word 2010). 'Colorful Grid Accent 3' (MS Word 2010). 'Colorful Grid Accent 4' (MS Word 2010). 'Colorful Grid Accent 5' (MS Word 2010). 'Colorful Grid Accent 6' (MS Word 2010). 'Grid table light' (MS Word 2013). 'Plain Table 1' (MS Word 2013). 'Plain Table 2' (MS Word 2013). 'Plain Table 3' (MS Word 2013). 'Plain Table 4' (MS Word 2013). 'Plain Table 5' (MS Word 2013). 'Grid Table 1 Light' (MS Word 2013). 'Grid Table 1 Light Accent 1' (MS Word 2013). 'Grid Table 1 Light Accent 2' (MS Word 2013). 'Grid Table 1 Light Accent 3' (MS Word 2013). 'Grid Table 1 Light Accent 4' (MS Word 2013). 'Grid Table 1 Light Accent 5' (MS Word 2013). 'Grid Table 1 Light Accent 6' (MS Word 2013). 'Grid Table 2' (MS Word 2013). 'Grid Table 2 Accent 1' (MS Word 2013). 'Grid Table 2 Accent 2' (MS Word 2013). 'Grid Table 2 Accent 3' (MS Word 2013). 'Grid Table 2 Accent 4' (MS Word 2013). 'Grid Table 2 Accent 5' (MS Word 2013). 'Grid Table 2 Accent 6' (MS Word 2013). 'List Table 1 Light' (MS Word 2013). 'List Table 1 Light Accent 1' (MS Word 2013). 'List Table 1 Light Accent 2' (MS Word 2013). 'List Table 1 Light Accent 3' (MS Word 2013). 'List Table 1 Light Accent 4' (MS Word 2013). 'List Table 1 Light Accent 5' (MS Word 2013). 'List Table 1 Light Accent 6' (MS Word 2013). 'List Table 2' (MS Word 2013). 'List Table 2 Accent 1' (MS Word 2013). 'List Table 2 Accent 2' (MS Word 2013). 'List Table 2 Accent 3' (MS Word 2013). 'List Table 2 Accent 4' (MS Word 2013). 'List Table 2 Accent 5' (MS Word 2013). 'List Table 2 Accent 6' (MS Word 2013). 'Footnote text' . 'Footnote text' . 'Footnote reference' . 'Endnote text' . 'Endnote text' . 'Endnote reference' . 'Line Number' . 'Heading 1' . 'Heading 2' . 'Heading 3' . 'Heading 4' . 'Heading 5' . 'Heading 6' . 'Heading 7' . 'Heading 8' . 'Heading 9' . Represents a style type enumeration. GemBox.Document Formats and Styles Paragraph style. Character style. List style. Table style. Represents a Table of Entries field, such as Table of Contents, Table of Figures, Table of Authorities, Index or Bibliography. is a element used to define fields that span more than one , as opposite to element that represent a fields that span only through single . Supported field types are: , , and . is a content element with TableOfEntries.Entries as a content property that accepts only s. GemBox.Document Content Model Create and Update Word TOC in C# and VB.NET Gets or sets a value indicating whether this is invalid and, because of that, it should be updated. The property value of true specifies that the result of this field is no longer based on the contents of the document, and should be recalculated whenever an application with this functionality reads the document (for example MS Word). if result of this is invalid and, because of that, it should be updated; otherwise, . Gets or sets a value indicating whether this is locked and, because of that, it should not be updated. This property is simply written to a Word document and has no effect on the behavior of this library. When a field is locked, Word applications will not update its results. if result of this is locked and, because of that, it should not be updated; otherwise, . Initializes a new instance of the class. The owner document. The field type. (supported are only , , and ). Initializes a new instance of the class. The owner document. The field type. (supported are only , , and ). The field's instruction text (switches). The table's entries. Initializes a new instance of the class. The owner document. The field type. (supported are only , , and ). The field's instruction text (switches). The table's entries. Gets the parent of this instance. The parent of this instance. Gets the field type. The field type. Gets or sets the field's instruction text (switches). The field's instruction text (switches). Gets the table's entries. The table's entries. Only supported element type is . GemBox.Document Content Model Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Performs an update on TOC (Table of Contents) field. method is used for updating entire TOC field with new entries. If is not specified method will set a default set of switches: \o "1-3" \h \u \z. GemBox.Document automatically updates page numbers in TOC entries only for PDF, XPS, and image formats, for DOCX format page numbers have a default value 1. Updating page numbers for TOC entries in DOCX can be achieved by creating an instance of , setting its to , and calling the GetPaginator(PaginatorOptions) method with that instance. Supported TOC switches: \o - Specifies the of enlisting header paragraphs.\u - Specifies enlistment of all paragraphs with not equal to BodyText.\t - Specifies enlistment of all paragraphs with defined custom styles.\f - Specifies a unique identifier for TC fields enlistment.\h - Specifies a usage.\n - Specifies the of entries with omitted page number.\l - Specifies the of enlisting TC fields.\p - Specifies the character that separates entry and its page number.\b - Specifies the name of the bookmark from which the paragraphs are enlisted. Supported TC switches: \f - TC field's unique identifier.\l - TC field's OutlineLevel.\n - Omit page number.For more information about TOC switches, see Field codes: TOC (Table of Contents) field.For more information about TC switches, see Field codes: TC (Table of Contents Entry) field. Create and Update Word TOC in C# and VB.NET Encapsulates a method used to create for specified row and column. Index of the row. Index of the column. A instance that encapsulated method creates. Represents a set of paragraphs (and other -level content) arranged in rows and columns. is a derived content element consisting of s. can be formatted using the Table.TableFormat property. Default width for table columns can be specified with Table.Columns property. For more information, see table examples. GemBox.Document Content Model Initializes a new instance of the class. The owner document. Initializes a new instance of the class with specified rows. The owner document. The table rows. Initializes a new instance of the class with specified rows. The owner document. The table rows. Initializes a new instance of the class with a specified number of row and column count and a method used to create s. The owner document. The row count. The column count. The table cell creator. Initializes a new instance of the class with a specified row and column count. The owner document. The row count. The column count. Gets the table rows. The table rows. Since class is , only supported element in this collection is . GemBox.Document Content Model Gets the table columns. The table columns. This collection does not reflect the structure of a (how many s are in each ), it is used just to specify a width for all s that are contained in the specific table column through . Gets the metadata (non-visual properties) of this instance. The metadata (non-visual properties) of this instance. Gets or sets the table format. The table format. Gets or sets the revision of the format of this table. This property contains the format which was applied to this table before the revision. The revision of the format of this table. The revision is internally stored as a member of . Using set property on overrides this revision. Gets or sets the revision of the table grid. This property contains the columns and their widths before this revision The revision of the table grid. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a single cell in a table row, which contains the table's content. is a content consisting of derived elements (s and s). can be formatted using the TableCell.CellFormat property. can be spanned through multiple rows and columns with and properties. For more information, see table examples. GemBox.Document Content Model Initializes a new instance of the class. The owner document. Initializes a new instance of the class with specified text. The owner document. The cell text. Initializes a new instance of the class with a specified content (s or s). The owner document. The cell content. Initializes a new instance of the class with a specified content (s or s). The owner document. The cell content. Gets the that contains this instance. The that contains this instance. Gets the parent of this instance. The parent of this instance. Gets the block elements that represent content of this instance. The block elements that represent content of this instance. Supports all derived elements: , and . GemBox.Document Content Model Gets or sets the column span. The column span. Default value is 1. Gets or sets the row span. The row span. Default value is 1. Gets or sets the table cell format. The table cell format. Gets or sets the revision information for the table cell. The revision information for the table cell. The revision is internally stored as a member of . Using set property on overrides this revision. Gets or sets the revision of the cell format of this table cell. This property contains the cell format which was applied to this cell before the revision. The revision of the cell format of this table cell. The revision is internally stored as a member of . Using set property on overrides this revision. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a collection of s. Used as a container for a TableRow.Cells property. GemBox.Document Content Model Represents a set of properties which shall be applied to a specific . Table Formatting example GemBox.Document Formats and Styles Initializes a new instance of the class. Gets or sets the preferred width of the . The preferred width of the . Gets or sets the vertical alignment of the text in the . The vertical alignment of the text in the . Gets or sets the table cell padding. The table cell padding. Gets or sets a value indicating whether the table cell content shall be allowed to wrap (the cell may be shrunk as needed if it is a fixed preferred width value, and the content shall be treated as having breaking characters if it is a percentage or automatic width value). if the table cell content shall be allowed to wrap; otherwise, . Gets or sets a value indicating whether the content of the table cell shall have its inter-character spacing increased or reduced as necessary to fit the width of the text extents of the table cell. if the content of the table cell shall have its inter-character spacing increased or reduced as necessary to fit the width of the text extents of the table cell; otherwise, . This feature is currently implemented differently when exporting a document to PDF, XPS, or image formats than in MS Word application. It is implemented by scaling table cell's content so it fits the size of the text extents of the table cell, and not by increasing or reducing inter-character spacing. Gets the table cell borders. The table cell borders. Gets or sets the table cell background color. The table cell background color. Gets or sets the direction of the text flow for table cell. The direction of the text flow for table cell. Determines whether the specified is equal to this instance. The to compare with this table cell format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first table cell format. The second table cell format. if and table cell formats are equal; otherwise, . Determines whether and  s are not equal. The first table cell format. The second table cell format. if and table cell formats are not equal; otherwise, . Clones this instance. Cloned . Clones this instance. If , the values to be cloned will be fetched from this object's resolved values. This means that even if a property was never explicitly set, this method will look into this format style or in the document's default formats to resolve the values and explicitly set them in the cloned object. Cloned . Represents a direction of the text flow for the parent element. The text in the parent element shall flow from left to right horizontally. The text in the parent element shall flow from top to bottom vertically. The text in the parent element shall flow from bottom to top vertically. The text in the parent element shall flow from top to bottom vertically, Asian characters will be rendered vertically, but other characters will be rotated 90 degrees to the right. The text in the parent element shall flow from top to bottom vertically, Asian characters will be rendered vertically, but other characters will be rotated 90 degrees to the left. Represents a logical column in a used to specify the presence of a shared vertical edge in the . Gets or sets the preferred width of the . The preferred width of the (in points). Works only if is set to . If is zero, then MS Word will take a value of a next non-zero , if it exists in the collection. Initializes a new instance of the class. Initializes a new instance of the class with a specified preferred width. Preferred width of the . Represents a set of s which define all of the shared vertical edges of the table, as well as default widths for each of these s. Used as a container for a Table.Columns property. Table could have less or more columns than the number of columns in this collection when it is rendered, depending on how many there are in each in a table. Initializes a new instance of the class. Initializes a new instance of the class with a specified table columns. The table columns. Represents a set of table-wide properties. These properties affect the appearance of all rows and cells within the parent table, but may be overridden by individual row and cell level formats. Table Formatting example GemBox.Document Formats and Styles Initializes a new instance of the class. Gets or sets the table style. The table style. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets or sets the table style options that specify which of the referenced conditional formats will be applied on the parent . The table style options that specify which of the referenced conditional formats will be applied on the parent . For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets or sets the number of rows in row band for this table style. The number of rows in row band for this table style. Row banding size must be equal or greater than zero. Row banding is a grouping of rows into two successively alternating groups (odd and even). specifies the size of the group. Each group (odd and even) can have its own table style conditional formatting specified. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets or sets the number of columns in column band for this table style. The number of columns in column band for this table style. Column banding size must be equal or greater than zero. Column banding is a grouping of columns into two successively alternating groups (odd and even). specifies the size of the group. Each group (odd and even) can have its own table style conditional formatting specified. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets or sets the table preferred width. The table preferred width. Gets or sets the alignment of the table with respect to the text margins in the section. The alignment of the table with respect to the text margins in the section. Only , and values are supported. Gets or sets the indentation that should shift the table into the text margin by the specified amount. The indentation that should shift the table into the text margin by the specified amount. Gets or sets the table background color. The table background color. Gets the table borders. The table borders. Gets the floating table positioning settings. The floating table positioning settings. Gets or sets the default table cell padding. The default table cell padding. Gets or sets the default table cell spacing (the spacing between adjacent cells and the edges of the table) for all cells in the parent table. The default table cell spacing (the spacing between adjacent cells and the edges of the table) for all cells in the parent table. Gets or sets a value indicating whether the table shall automatically resize to fit contents. if the table shall automatically resize to fit contents; otherwise, . Gets or sets a value indicating whether the cells in this table shall be visually represented in a right to left direction. if the cells in this table shall be visually represented in a right to left direction; otherwise, . When this property is specified, then the ordering of all cells (and table-level properties) in this table shall be applied to the table assuming that the table is a normal left to right table, but the table cells shall be displayed in a right to left direction. Example: A left border on the first table cell must be displayed on the right side of that cell (which would be the rightmost cell) in a visually right to left table. Determines whether the specified is equal to this instance. The to compare with this table format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first table format. The second table format. if and table formats are equal; otherwise, . Determines whether and  s are not equal. The first table format. The second table format. if and table formats are not equal; otherwise, . Clones this instance. Cloned . Clones this instance. If , the values to be cloned will be fetched from this object's resolved values. This means that even if a property was never explicitly set, this method will look into this format style or in the document's default formats to resolve the values and explicitly set them in the cloned object. Cloned . Represents a set of non-visual properties which shall be applied to the parent element. Gets or sets the alternative title, a text-based representation of the information contained in the parent element. The alternative title text for the table element, for use by assistive technologies or applications which will not display the table element. Gets or sets the alternative description, a text-based representation of the information contained in the parent element. The alternative description text for the table element, for use by assistive technologies or applications which will not display the table element. Represents floating table positioning settings. Gets or sets the table horizontal position. The table horizontal position. Supported positions are relative to , or . This property is obsolete. Use TablePositioning.HorizontalPosition property instead. To change horizontal position base, use new instance of struct. Gets or sets the base object from which the horizontal positioning should be calculated. The base object from which the horizontal positioning should be calculated. Supported values are , and . Gets or sets the table vertical position. The table vertical position. Supported positions are relative to , or . This property is obsolete. Use TablePositioning.VerticalPosition property instead. To change vertical position base, use new instance of struct. Gets or sets the base object from which the vertical positioning should be calculated. The base object from which the vertical positioning should be calculated. Supported values are , and . Gets or sets the minimum distance which shall be maintained between the current floating table and the text in the paragraph which is surrounding this floating table. The minimum distance which shall be maintained between the current floating table and the text in the paragraph which is surrounding this floating table. Clears floating table positioning settings. Determines whether the specified is equal to this instance. The to compare with this table positioning instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first table positioning. The second table positioning. if and table positionings are equal; otherwise, . Determines whether and  s are not equal. The first table positioning. The second table positioning. if and table positionings are not equal; otherwise, . Represents a single table row, which contains the table's cells. is a content consisting of elements. can be formatted using the TableRow.RowFormat property. For more information, see table examples. GemBox.Document Content Model Initializes a new instance of the class. The owner document. Initializes a new instance of the class with a specified cells. The owner document. The table cells. Initializes a new instance of the class with a specified cells. The owner document. The table cells. Gets the that contains this instance. The that contains this instance. Gets the parent of this instance. The parent of this instance. Gets the table cells contained in this row. The table cells contained in this row. Since class is , only supported element in this collection is . GemBox.Document Content Model Gets or sets the table row format. The table row format. Gets or sets the revision information for the table row. The revision information for the table row. The revision is internally stored as a member of . Using set property on overrides this revision. Gets or sets the revision of the row format of this table row. This property contains the row format which was applied to this row before the revision. The revision of the row format of this table row. The revision is internally stored as a member of . Using set property on overrides this revision. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a collection of s. Used as a container for a Table.Rows property. GemBox.Document Content Model Removes the at the specified index of the . The zero-based index of the to remove. Removes the first occurrence of a specific from the . The from the . if row is successfully removed; otherwise, . This method also returns if row was not found in the . Represents a set of row-level properties applied to the element. Table Formatting example GemBox.Document Formats and Styles Initializes a new instance of the class. Gets or sets the table row height. The table row height. Gets or sets a value indicating whether all contents of a table row shall be rendered on the same page. if splitting the table row across multiple pages is allowed; otherwise, . Gets or sets a value indicating whether the table row shall be repeated at the top of each new page on which part of it's table is displayed. if table row shall be repeated at the top of each new page on which part of its table is displayed; otherwise, . Gets or sets a value indicating whether shall be hidden from display at display time in a document. if shall be hidden from display at display time in a document; otherwise, . Determines whether the specified is equal to this instance. The to compare with this table row format instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first table row format. The second table row format. if and table row formats are equal; otherwise, . Determines whether and  s are not equal. The first table row format. The second table row format. if and table row formats are not equal; otherwise, . Clones this instance. Cloned . Clones this instance fetching the clone values from this object resolved values (the same values you get accessing the properties directly instead of accessing it through the ). If , the values to be cloned will be fetched from this object's resolved values. This means that even if a property was never explicitly set, this method will look into this format style or in the document's default formats to resolve the values and explicitly set them in the cloned object. Cloned . Represents a table row height. Initializes a new instance of the struct. The table row height value. The table row height rule. Gets the table row height value. The table row height value. Gets the table row height rule. The table row height rule. Determines whether the   is equal to this instance. The other table row height to compare with this table row height instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this table row height instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first table row height. The second table row height. if and table row heights are equal; otherwise, . Determines whether and  s are not equal. The first table row height. The second table row height. if and table row heights are not equal; otherwise, . Represents the logic which shall be used to calculate the height of the when it is displayed in the document. The height of the shall be automatically determined by the size of its content, with no predetermined minimum or maximum size. The height of the shall be at least the value specified, but may be expanded to fit its content as needed. The height of the shall be exactly the value specified, regardless of the size of its content. If the content is too large for the specified height, then it shall be clipped. Represents a style which can be applied to one or more s within a document content. Styles provide a way to format your document in a consistent way so when you change your formatting options on a style, all document elements referencing that style will be changed. To apply a to a , set it to a TableFormat.Style property on a Table.TableFormat. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Initializes a new instance of the class. The style name. Gets a collection of conditional s. A collection of conditional s. Table style conditional formats are applied to different regions of the table and allow you to define all formatting properties (formatting for a table, rows, cells, paragraphs and runs). For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets or sets the table format. The table format. Table styles article Table styles example Gets or sets the table row format. The table row format. Table styles article Table styles example Gets or sets the table cell format. The table cell format. Table styles article Table styles example Gets or sets the paragraph format. The paragraph format. Table styles article Table styles example Gets or sets the character format. The character format. Table styles article Table styles example Gets or sets the style on which this style is based. The base style. Represents a set of table style conditional formatting properties. These properties affect the appearance of all rows, cells, paragraphs and runs within the parent table matching the specified condition, but may be overridden by individual row, cell, paragraph and run level formats. Table style conditional formats are applied to different regions of the table and allow you to define all formatting properties (formatting for a table, rows, cells, paragraphs and runs). For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets the table style conditional format type. The table style conditional format type. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Initializes a new instance of the class. The table style conditional format type. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets or sets the table format. The table format. Table styles article Table styles example Gets or sets the table row format. The table row format. Table styles article Table styles example Gets or sets the table cell format. The table cell format. Table styles article Table styles example Gets or sets the paragraph format. The paragraph format. Table styles article Table styles example Gets or sets the character format. The character format. Table styles article Table styles example Gets the owner document. The owner document. Represents a collection of conditional s. Table style conditional formats are applied to different regions of the table and allow you to define all formatting properties (formatting for a table, rows, cells, paragraphs and runs). For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Gets the that corresponds to given format type. If doesn't contain corresponding format, then new format will be added and returned. The that corresponds to given format type. The format type of the . The that corresponds to given format type. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Determines whether the contains a instance with specific format type. Format type of the to locate in the . if instance with specific format type is found in the ; otherwise, . For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Removes the with the specified format type from the . Format type of the which should be removed from the . if is successfully removed; otherwise, . This method also returns if was not found in the . For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Clears the . Sets the specified formats. This method is required to support C# collection initializer syntax. The style format. Returns an enumerator that iterates through the . A IEnumerator<TableStyleFormat> that can be used to iterate through the . Returns an enumerator that iterates through the . An object that can be used to iterate through the . Represents table style conditional format types which indicate what region of a table will be formatted with its parent . When specified, these conditional formats shall be applied in the following order (therefore subsequent formats override properties on previous formats). For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Specifies that the conditional formatting applies to the whole table. Specifies that the table formatting applies to odd numbered groupings of rows. Specifies that the table formatting applies to even numbered groupings of rows. Specifies that the table formatting applies to odd numbered groupings of columns. Specifies that the table formatting applies to even numbered groupings of columns. Specifies that the table formatting applies to the first column. Specifies that the table formatting applies to the last column. Specifies that the table formatting applies to the first row. Specifies that the table formatting applies to the last row. Specifies that the table formatting applies to the top left cell. Specifies that the table formatting applies to the top right cell. Specifies that the table formatting applies to the bottom left cell. Specifies that the table formatting applies to the bottom right cell. Specifies which table style conditional formats are applied to a table. For more information about table styles, see table styles article and table styles example. Table styles article Table styles example Do not apply any conditional formatting. Apply first row conditional formatting. Apply last row conditional formatting. Apply first column conditional formatting. Apply last column conditional formatting. Apply row banding conditional formatting. Row banding is a grouping of rows into two successively alternating groups (odd and even). Group size is specified by . Each group (odd and even) can have its own table style conditional formatting specified. Apply column banding conditional formatting. Column banding is a grouping of columns into two successively alternating groups (odd and even). Group size is specified by . Each group (odd and even) can have its own table style conditional formatting specified. Apply all conditional formats. Represents a table width encapsulating table width value and table width measurement unit. Represents an automatic table width. Initializes a new instance of the struct with specified value and measurement unit. The table width value. The table width measurement unit. Gets the table width value. The table width value (in unit specified in property). Gets the table width measurement unit. The table width measurement unit. Determines whether the   is equal to this instance. The other table width to compare with this table width instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this border instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Returns a that represents this instance. A that represents this instance. Determines whether and  s are equal. The first table width. The second table width. if and table widths are equal; otherwise, . Determines whether and  s are not equal. The first table width. The second table width. if and table widths are not equal; otherwise, . Represents a table width measurement unit. Specifies that the value for the measurement of the current table width property in the parent table shall be automatically determined by the table layout algorithm when the table is displayed (this width can be adjusted as appropriate). Specifies that the value for the measurement of the current table width property in the parent table shall be interpreted in points. Specifies that the value for the measurement of the current table width property in the parent table shall be interpreted as a percent. These percentages shall be calculated relative to the extents specified by the parent element. Specifies the possible extents which can be used to calculate the absolute positioning of this positional tab character. Specifies that the absolute positioning of the tab shall be relative to the margins. Specifies that the absolute positioning of the tab shall be relative to the indents. Represents a single custom tab stop within a set of custom tab stops applied at ParagraphFormat.Tabs property. Creating customized tabs in a document is accomplished with structure that enables you to define tab position, tab leader character and surrounding text alignment. s should be inserted into ParagraphFormat.Tabs collection to be used in a . Tabs are inserted into a document content with elements that have SpecialCharacter.CharacterType property equal to . Values and are currently not supported in PDF, XPS and image file formats. ParagraphFormat.Tabs Initializes a new instance of the struct. The tab stop position. The tab stop alignment. The tab stop leader. Initializes a new instance of the struct. The tab stop position. The tab stop alignment. Gets the position of the current , in points, with respect to the current page margins. The position of the current , in points, with respect to the current page margins. Gets the alignment of the current , which determines the behavior of the tab stop and the alignment which shall be applied to text entered at the current . The alignment of the current . Gets the character which shall be used to fill in the space created by a tab which ends at this . The character which shall be used to fill in the space created by a tab which ends at this . Determines whether the   is equal to this instance. The other tab stop to compare with this tab stop instance. if the   is equal to this instance; otherwise, . Determines whether the specified is equal to this instance. The to compare with this tab stop instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first tab stop. The second tab stop. if and tab stops are equal; otherwise, . Determines whether and  s are not equal. The first tab stop. The second tab stop. if and tab stops are not equal; otherwise, . Represents the available alignments for custom , which determines the behavior of the and the alignment which shall be applied to text entered at the current custom . Creating customized tabs in a document is accomplished with structure that enables you to define tab position, tab leader character and surrounding text alignment. s should be inserted into ParagraphFormat.Tabs collection to be used in a . Tabs are inserted into a document content with elements that have SpecialCharacter.CharacterType property equal to . Values and are currently not supported in PDF, XPS and image file formats. Specifies that the current tab stop is cleared and shall be removed and ignored when processing the contents of the document. Specifies that the current tab stop shall result in a location in the document where all following text is left aligned (i.e. all text runs following this tab stop and preceding the next tab stop shall be left aligned with respect to the tab stop location). Specifies that the current tab stop shall result in a location in the document where all following text is centered (i.e. all text runs following this tab stop and preceding the next tab stop shall be centered around the tab stop location). Specifies that the current tab stop shall result in a location in the document where all following text is right aligned (i.e. all text runs following this tab stop and preceding the next tab stop shall be right aligned with respect to the tab stop location). Specifies that the current tab stop shall result in a location in the document where all following text is aligned around the first decimal character in the following text runs. All text runs before the first decimal character shall be before the tab stop, all text runs after it shall be after the tab stop location. Specifies that the current tab is a bar tab. A bar tab is a tab which does not result in a custom tab stop in the parent paragraph (this tab stop location shall be skipped when positioning custom tab characters), but instead shall be used to draw a vertical line (or bar) at this location in the parent paragraph. Specifies that the current tab is a list tab, which is the tab stop between the numbering and the paragraph contents in a numbered paragraph. Represents a set of s. Creating customized tabs in a document is accomplished with structure that enables you to define tab position, tab leader character and surrounding text alignment. s should be inserted into ParagraphFormat.Tabs collection to be used in a . Tabs are inserted into a document content with elements that have SpecialCharacter.CharacterType property equal to . Values and are currently not supported in PDF, XPS and image file formats. ParagraphFormat.Tabs Searches for the specified element and returns the zero-based index of the first occurrence within the entire . The element to locate in the . The zero-based index of the first occurrence of item within the entire , if found; otherwise, -1. Inserts an element into the at the specified index. The zero-based index at which should be inserted. The element to insert. Removes the element at the specified index of the . The zero-based index of the element to remove. Gets or sets the at the specified index. The at the specified index. The zero-based index of the to get or set. The at the specified index. Adds an object to the end of the . The object to be added to the end of the . Removes all elements from the . Determines whether an element is in the . The element to locate in the . true if item is found in the ; otherwise, false. Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. The one-dimensional array that is the destination of the elements copied from . The zero-based index in array at which copying begins. Gets the number of s contained in the . The number of s contained in the . Removes the first occurrence of a specific element from the . The element from the . true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the . Returns an enumerator that iterates through the . An enumerator for the . Determines whether the specified is equal to this instance. The to compare with this tab stop collection instance. if the specified is a and is equal to this instance; otherwise, . Returns a hash code for this instance. An integer value that specifies a hash value for this instance. Determines whether and  s are equal. The first tab stop collection. The second tab stop collection. if and tab stop collections are equal; otherwise, . Determines whether and  s are not equal. The first tab stop collection. The second tab stop collection. if and tab stop collections are not equal; otherwise, . Represents the characters which may be used to fill in the space created by a tab which ends at this custom . The chosen character shall be repeated as required to completely fill the tab spacing generated by the tab character. Creating customized tabs in a document is accomplished with structure that enables you to define tab position, tab leader character and surrounding text alignment. s should be inserted into ParagraphFormat.Tabs collection to be used in a . Tabs are inserted into a document content with elements that have SpecialCharacter.CharacterType property equal to . Values and are currently not supported in PDF, XPS and image file formats. Specifies that there shall be no leader character. Specifies that the leader character shall be a dot [.]. Specifies that the leader character shall be a hyphen [-]. Specifies that the leader character shall be an underscore [_]. Represents an enumeration of available text fitting options. Text within the should not be auto-fit to the bounding box. Text within the should be auto-fit to the bounding box by reducing the font size of each and line spacing of each in the . This value is currently not supported in PDF, XPS, and image formats. should be auto-fit to fully contain the text described within it. Represents a which serves as a container for elements which are outside page main content flow. is a content consisting of derived elements (s and s). 's shape type (geometry) is represented by enumeration. It can be set only through constructor and retrieved from property. can be filled with a and outlined with a . can be positioned in-line with the rest of the document content or floating within document content. For more information, see remarks for DrawingElement.Layout property. Imported text frames are converted to TextBoxes and will be exported back as text frames, if there were no changes to the following properties: , or . Any changes to those properties will result in a text frame being exported as a . GemBox.Document Content Model GemBox.Document Shapes and Layout Text Boxes example Gets the block elements that represent content of this instance. The block elements that represent content of this instance. Supports and elements. GemBox.Document Content Model Initializes a new instance of empty with specified layout (position and size) and shape type. The owner document. The text-box layout (position and size). The text-box shape type. is . Initializes a new instance of empty with specified layout (position and size). The owner document. The text-box layout (position and size). is . Initializes a new instance of the class with specified layout (position and size) and content. The owner document. The text-box layout (position and size). The text-box content. is . is . Initializes a new instance of the class with specified layout (position and size) and content. The owner document. The text-box layout (position and size). The text-box content. is . Gets the text box format. The text box format. Gets the element type for which is . The value. Clones this instance. If set to clone all descendants recursively; otherwise clone only current . Cloned . Document content element instance can exist only in a one place in the document. If you want to insert document content element into some other part of the same document, then clone the element and insert its clone. If you want to insert document content element into another document, then you should first import it into another document with method and then insert the imported element. For more information, see cloning example. Represents a column in a . Document content can be presented with more than one column, like in newspapers. To present a document with multiple columns, insert into PageSetup.TextColumns property on a parent . For more information about , see page setup example. Gets or sets the width of the column (in points). Set this property only if is false. The width of the column (in points). Gets or sets the space between two columns (in points). Set this property only if is false. The default value for this property is 35.4 points. The space between two columns (in points). Represents a collection of s in a . This collection is read-only. To change 's columns, assign a new instance of a to a property on a parent . Gets or sets a value indicating whether to show or not the line between two . to show the line between two ; otherwise, . Initializes a new instance of the class. The number of text columns. Gets or sets a value indicating whether all text columns have equal width and are evenly spaced. if all columns have equal width and are evenly spaced; otherwise, . Gets or sets the amount of space between each column (in points). Set this property only if is . The default value for this property is 35.4 points. The amount of space between each column (in points). Represents an enumeration of available text directions. Horizontal text. Text has vertical orientation (each line is 90 degrees rotated clockwise, so it goes from top to bottom; each next line is to the left from the previous one). Text has vertical orientation (each line is 270 degrees rotated clockwise, so it goes from bottom to top; each next line is to the right from the previous one). Represents the text watermark that appears behind the document content. Initializes a new instance of the text watermark with the default width and height. The owner document. The text of the watermark. Initializes a new instance of the text watermark with the given width and height. The owner document. The text of the watermark. The width of the watermark (in points). The height of the watermark (in points). Initializes a new instance of the text watermark with the given width and height. The owner document. The text of the watermark. The width of the watermark. The height of the watermark. The used length unit. Gets or sets the size of the watermark shape. To set the size as default, use empty size. The size of the watermark shape. The height of the TextWatermark is ignored when saving to PDF, XPS, and image formats. This is because GemBox.Document currently doesn't support scaling of characters in these formats which is necessary to support height independently of width. Currently the width is used and height is calculated to naturally fit the chosen font. Gets or sets the text of the watermark. The text of the watermark. Gets or sets the font name used for the watermark. The font name used for the watermark. Gets or sets the font color used for the watermark. The font color used for the watermark. Changing the font color also changes the transparency of the text which can affect the property. Gets or sets whether the text of the watermark will be semitransparent. The default value is true. True if the text of the watermark should be semitransparent, false otherwise. Gets the underlying TextBox that represents the watermark. The TextBox that represents the watermark. Sets the text of the watermark as diagonal (rotated). Sets the text of the watermark as horizontal. Specifies how text is wrapped around a floating element. Values and are currently not supported in PDF, XPS, and image formats. This field is obsolete. Use type instead. Put element in line with text. Wrap text as square around floating element. Wrap text tight to the floating element. Wrap text tight and inside open parts of the floating element. Put text above and below of the floating element. Put floating element behind text. Put floating element in front of text. An enumeration of supported compression schemes for Tagged Image File Format (TIFF) when saving a to an image using an . The encoder attempts to save the bitmap with the best possible compression schema. The Tagged Image File Format (TIFF) image will not be compressed. The CCITT3 compression schema. The CCITT4 compression schema. The LZW compression schema. The RLE compression schema. Zip compression schema. Represents a revision of the character format. Initializes a new instance of the class. The owner document. Gets or sets the character format that was used before this revision was applied. The character format that was used before this revision was applied. Represents an element that is used to start or end a move range. The types of separators are:
  • MoveFromRangeStart - the start of the range that wraps the elements that were moved from this position.
  • MoveFromRangeEnd - the end of the range that wraps the elements that were moved from this position.
  • MoveToRangeStart - the start of the range that wraps the elements that were moved to this position.
  • MoveToRangeEnd - the end of the range that wraps the elements that were moved to this position.
 Initializes a new instance of the class. The owner document. The value indicating whether this element is the start of the move range or the end. The value indicating whether this element represents the position from which the contained elements were moved or the position to which the contained elements were moved. The ID of the move. The name of the move. Gets or sets the ID of the move. The ID of the move. The IDs of the move range's start and end should match in order for MS Word to display the move correctly. Gets or sets the author of the move. The author of the move. Gets or sets the date when the move was created. The date when the move was created. Gets or sets the name of the move. The name is used to tie together the move from and move to elements The name of the move. The name of the move from range and the move to range should match in order for MS Word to display the move correctly. The name of the end range is null and setting it's value has no effect. Gets or sets a value indicating whether this element is the start of the move range or the end. The value indicating whether this element is the start of the move range or the end. Gets or sets a value indicating whether this element represents the position from which the contained elements were moved or the position to which the contained elements were moved. The value indicating whether this elements represents the position from which the contained elements were moved or the position to which the contained elements were moved. Represents a revision of the paragraph format. Initializes a new instance of the class. The owner document. Gets or sets the paragraph format that was used before this revision was applied. The paragraph format that was used before this revision was applied. Gets or sets the list format that was used before this revision was applied. The list format that was used before this revision was applied. Represents a single revision in the document. Initializes a new instance of the class. Gets or sets the author of the revision. The author of the revision. Gets or sets the date when the revision was created. The date when the revision was created. Gets the type of this revision. The type of this revision. Accepts this revision. Rejects this revision. Represents the revisions in the document Accept all revisions in the document. Revisions that are not supported by the model of GemBox.Document (e.g. revisions of preserved inlines) will not be affected Reject all revisions in the document. Revisions that are not supported by the model of GemBox.Document (e.g. revisions of preserved inlines) will not be affected Represents the available revision colors. Represents #000000 color. Represents #2e97d3 color. Represents #84a35b color. Represents #fce6f4 color. Represents #e1f2fa color. Represents #fef4de color. Represents #eadfef color. Represents #dff8ce color. Represents #fce3d0 color. Represents #376e96 color. Represents #881824 color. Represents #e09a2b color. Represents #a0a3a9 color. Represents #50565e color. Represents #2c6234 color. Represents #ce338f color. Represents #b5082e color. Represents #1b9cab color. Represents #3eafc2 color. Represents #633277 color. Represents #ffffff color. Represents #fad272 color. Represents revision options that specify how the revisions will be displayed in the document. This class is currently supported only when saving to PDF, XPS, or image formats. Gets or sets which revision types should be visible. Revision types which should be visible. By default, no revisions are visible Gets or sets the decoration effect which should be applied on the inserted content. The decoration effect which should be applied on the inserted content. The default value is . Gets or sets the color which should be used for the inserted content. The color which should be used for the inserted content. The default value is . Gets or sets the decoration effect which should be applied on the deleted content. The decoration effect which should be applied on the deleted content. The default value is . Gets or sets the color which should be used for the deleted content. The color which should be used for the deleted content. The default value is . Gets or sets the decoration effect which should be applied on the content with revised formatting. The decoration effect which should be applied on the content with revised formatting. The default value is . Gets or sets the color which should be used for the content with revised formatting. The color which should be used for the content with revised formatting. The default value is . Gets or sets the decoration effect which should be applied on the content that was moved from the current position. The decoration effect which should be applied on the content that was moved from the current position. The default value is . Gets or sets the color which should be used for the content that was moved from the current position. The color which should be used for the content that was moved from the current position. The default value is . Gets or sets the decoration effect which should be applied on the content that was moved to the current position. The decoration effect which should be applied on the content that was moved to the current position. The default value is . Gets or sets the color which should be used for the content that was moved to the current position. The color which should be used for the content that was moved to the current position. The default value is . Gets or sets the color which should be used for the background of the inserted cells. The color which should be used for the background of the inserted cells. The default value is . Gets or sets the color which should be used for the background of the deleted cells. The color which should be used for the background of the deleted cells. The default value is . Initializes a new instance of the class. Represents the available revision text effects. Revised text has no special formatting applied. Revised text is highlighted with color only. Revised text is bold and colored. Revised text is italic and colored. Revised text is underlined and colored. Revised text is double underlined and colored. Revised text is stroked through and colored. Revised text is double stroked through and colored. Defines the type of the revision. The revision represents the insertion of an element. The revision represents the removal of an element. The revision represents the move of an element away from the position. The revision represents the move of an element to the position. The revision represents the change of the formatting. Represents a revision of the section properties. Initializes a new instance of the class. The owning document Gets or sets the page setup that was used before this revision was applied. The page setup that was used before this revision was applied. Gets the footnote settings. The footnote settings. Gets the endnote settings. The endnote settings. Represents available revision types that can be shown in the resulting document. Don't show any revisions. Insertion revision type. Deletion revision type. Formatting revision type. Moved from revision type. Moved to revision type. All revision types. Represents a revision of the table cell format. Initializes a new instance of the class. The owner document. Gets or sets the table cell format that was used before this revision was applied. The table cell format that was used before this revision was applied. Represents a revision of the tables columns. Initializes a new instance of the class. Gets the column that the table contained before this revision. The column that the table contained before this revision. This collection does not reflect the structure of a (how many s are in each ), it is used just to specify a width for all s that are contained in the specific table column through . Represents a revision of the table format. Initializes a new instance of the class. The owner document. Gets or sets the table format that was used before this revision was applied. The table format that was used before this revision was applied. Represents a revision of the table row format. Initializes a new instance of the class. The owner document. Gets or sets the table cell format that was used before this revision was applied. The table cell format that was used before this revision was applied. Represents a class that stores loading options for plain text (TXT) format. Initializes a new instance of the class. Gets or sets the encoding for the TXT file. The encoding for the TXT file. Value is set to . Represents options for saving to plain text (TXT) format. Initializes a new instance of the class. Gets the content-type for TXT file format: "text/plain; charset=" + .. The content-type for TXT file format. Gets or sets the encoding for the TXT file. The encoding for the TXT file. Value is set to . Gets or sets the string to use as a paragraph break. Default value is . The string to use as a paragraph break. to include es, to skip them. The default value is . Represents the types of patterns which may be used to create the underline applied beneath the text in a . Values and are currently not supported in PDF, XPS, and image formats. Specifies no underline beneath the run. Specifies an underline consisting of a single line beneath all characters in the run. Specifies an underline consisting of two lines beneath all characters in the run. Specifies an underline consisting of a series of dot characters beneath all characters in the run. Specifies an underline consisting of a dashed line beneath all characters in the run. Specifies an underline consisting of a series of dot, dash characters beneath all characters in the run. Specifies an underline consisting of a series of dot, dot, dash characters beneath all characters in the run. Specifies an underline consisting of a single wavy line beneath all characters in the run. Specifies an underline consisting of a pair of wavy lines beneath all characters in the run. Specifies an underline consisting of a single line beneath all non-space characters in the run. There shall be no underline beneath any space character (breaking or non-breaking). Represents a dictionary that contains key and value pairs. keys cannot be or . Represents the module in . Gets or sets the name of . Gets or sets the code of . Gets the type of . Represents the collection of . Represents the collection of . Gets the number of elements contained. Gets the at the specified index. The zero-based index of the to get. that corresponds to the given index. Gets the with the given name. Name of the to get. that corresponds to the given name. Creates and returns a new with the given name and with the type of . Name of the returning . that is created and added to the collection. Removes all items from the collection. Indicates whether this collection contains the object with the specified . The name of the module to locate. if the collection contains an item with the ; otherwise, . Returns an enumerator that iterates through the collection. A that can be used to iterate through the collection. Removes the by name. Name of the contained in the collection. Removes the given . The that will be removed from this collection. Removes the from the given index. The index of the that will be removed. Tries to get the with the specified . Name of the contained in the collection. The found with the given . if the collection contains an item with the ; otherwise, . Creates and returns a new with the given name and type. Name of the returning . Type of the returning . that is created and added to the collection. Clones and returns a new from the given module. Source to be cloned. that is cloned and added to the collection. Represents the type of . A collection of subroutines and functions. A type of VBA project item that specifies a module for embedded macros and programmatic access operations that are associated with a document. A module that contains the definition for a new object. Each instance of a class creates a new object, and procedures that are defined in the module become properties and methods of the object. A VBA module that extends the methods and properties of an ActiveX control that has been registered with the project. Represents the VBA project. Gets all objects. Gets or sets the name of the . Deletes this VBA project from the workbook. Represents a vertical alignment for text or picture between the top and bottom margins of the parent element. The text/picture shall be vertically aligned to the top margin of the parent element, by moving all text/picture to the top text/picture extent within the parent element as required. The text/picture shall be vertically aligned to the center of the parent element. The text/picture shall be vertically aligned to the bottom margin of the parent element, by moving all text/picture to the bottom text/picture extent within the parent element as required. 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. Specifies that the parent object shall be vertically anchored to the text margins. Specifies that the parent object shall be vertically anchored to the page edge. Specifies that the parent object shall be vertically anchored to the text extents. Specifies that the vertical positioning shall be relative to the line containing the anchor character. Specifies that the vertical positioning shall be relative to the top margin of the current page. Specifies that the vertical positioning shall be relative to the bottom margin of the current page. Specifies that the vertical positioning shall be relative to the inside margin of the current page. Specifies that the vertical positioning shall be relative to the outside margin of the current page. Specifies that the vertical positioning shall be relative to the top left corner of the parent. Represents a set of possible relative vertical positions for the parent floating element. This relative position is specified relative to the vertical anchor specified by the parent . Specifies that the parent object should have absolute vertical positioning with respect to the anchor settings. Specifies that the parent object shall be vertically aligned to the top edge of the anchor object. Specifies that the parent object shall be vertically centered with respect to the anchor object. Specifies that the parent object shall be vertically aligned to the bottom edge of the anchor object . Specifies that the parent object shall be vertically aligned to the edge of the anchor object, and positioned inside that object. Specifies that the parent object shall be vertically aligned to the edge of the anchor object, and positioned outside that object. Represents the view options for the . Supported only in DOCX and DOC formats and partially in PDF format. are used to define document view and zoom when document is viewed in an application such as Microsoft Word or Adobe Reader. For more information, see view options example. Initializes a new instance of the class. Gets or sets the type of the view. The type of the view. Gets or sets the zoom. Zoom can be between 10% and 500%. Default value is 100%. The zoom. Clones this instance. Cloned . Represent view type. are used to define document view when document is viewed in an application such as Microsoft Word or Adobe Reader. For more information, see view options example. Default view. Normal view. Master pages view. Outline view. Print view. Web view. Full screen view. Supported only in PDF format. Bookmarks panel visible. Supported only in PDF format. Represents the watermark that appears behind the document content. Provides helper methods for dealing with Windows Presentation Foundation (WPF) dispatcherresource leaks in multithreaded applications. GemBox uses or might use WPF for the following operations: printing, converting to an XpsDocument or an ImageSource, saving to an XPS file or an image file, getting page or drawing content as FrameworkElement, bitmap decoding and encoding, rasterizing the vectorized content, text formatting (shaping), converting colors between custom color spaces, transferring data to and from the system Clipboard, and other. For some of these operations, such as printing and converting to an ImageSource, the use of WPF is mandatory because no alternative is currently provided or possible. For other operations, an alternative to WPF might be used instead. For example, for saving to an XPS file or an image file and rasterizing the vectorized content, Skia (via SkiaSharp NuGet package) might be used instead. For bitmap decoding and encoding, GDI+, Skia, or internal GemBox implementation might be used instead. And for text shaping, HarfBuzz (via HarfBuzzSharp NuGet package) or internal GemBox implementation might be used instead. If WPF is used in a non-WPF application or in a WPF application but not in its main (UI) thread, the instance of a Dispatcher class is implicitly created for each thread in which WPF is used and this instance must be shutdown before the thread terminates, otherwise the resource leak happens. The Dispatcher shutdown must be invoked in the same thread in which the Dispatcher was created. Since GemBox doesn't know if the code running after the GemBox code in the same thread might use WPF (and therefore require a Dispatcher instance that is not shutdown) nor GemBox has an option to be notified before a thread terminates (to shutdown the Dispatcher then and prevent the resource leak), GemBox won't use WPF in a thread that doesn't already have an associated Dispatcher or if it was already shutdown. In other words, GemBox guarantees that its code won't initiate a creation of a Dispatcher instance in any currently existing thread, except those listed below, thus preventing the resource leak. Therefore, for operations for which the use of WPF is not mandatory, an alternative to WPF will be used instead, and for operations for which the use of WPF is mandatory, GemBox will create a new thread, associate a new Dispatcher with it, use WPF in that thread, and shutdown the Dispatcher before that thread terminates thus preventing the resource leak. In the meantime, the current thread will wait for this thread to terminate via the Join method. For reasons explained below, GemBox might still initiate a creation of a Dispatcher instance in the following threads without shutting it down, thus allowing the resource leak to happen: The thread in which you set the to because with this operation you explicitly allow the thread to leak resources. The main (primary) thread of your application because when it terminates, the application's process exists and the operating system reclaims all used resources. Threads whose name ends with 'GemBox WPF background thread' because GemBox component and testing infrastructure relies on this. If you want GemBox to use WPF (for operations for which the use of WPF is mandatory) or to consider using WPF (for operations for which an alternative to WPF might be used instead) in the current thread, you must create a Dispatcher instance for the current thread and you mustshutdown the Dispatcher before that thread terminates to prevent the resource leak. A utility method can be used for this purpose. The returned must be disposed before the current thread terminates to shutdown the newly createdDispatcher and prevent the resource leak. If the of the returned is then GemBox will use or consider using WPF in the current thread; otherwise, if the value is , GemBox won't use WPF in the current thread because its Dispatcher is already shutdown. You should create and shutdown the Dispatcher instance for the current thread (for example, with the method and the returned ) only if you created the current thread or it is the main (primary) thread of your application. Otherwise, the thread might belong to the managed thread pool and/or the code running after your code in that thread might use WPF and therefore require a Dispatcher instance that is not shutdown. WPF Threading Model WPF Architecture - System.Threading.DispatcherObject HwndWrapper leaks class registrations (ATOMs returned by RegisterClassEx) Atom table leak after window running on a separate thread closes (Check the demo) Atom Table Monitor Gets or sets the maximum number of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive, thus leaking resources. If the value is negative, then counting of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive is not performed. Default value: -1. The maximum number of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive. For diagnostics purposes of reliably detecting the dispatcherresource leaks in multithreaded applications, you can set the value of the property to a non-negative value and optionally use in each newly created thread. If you want the current thread to be excluded from this verification and allow it to leak resources, set the to . Setting the to also enables GemBox to use or consider using WPF in the current thread without GemBox shutting down the associated Dispatcher instance thus allowing GemBox code to leak resources. Gets or sets the value whether the Dispatcher instance associated with the current thread must be shutdown before the current thread terminates in the context of verification done by the method. The default list of threads whose associated Dispatcher instance doesn't have to be shutdown are listed in the remarks of the class. to include the current thread to the the verification done by the method; otherwise, to exclude the current thread from the the verification done by the method thus allowing it to leak resources. Iterates over the list of threads in which was called and counts the number of Dispatcher instances associated with terminated threads that have not been shutdown while their associated thread was alive, thus leaking resources, and throws an if that number is greater than the . If the value of the is negative, then this method does nothing. The application is leaking more resources that specified by the limit. Please read the documentation of the class for more information how to prevent the resource leak. Creates a Dispatcher instance for the current thread if it was not already created. The returned must be disposed before the current thread terminates to shutdown the newly createdDispatcher and prevent the resource leak. Use this method if you want GemBox to use WPF (for operations for which the use of WPF is mandatory) or to consider using WPF (for operations for which an alternative to WPF might be used instead) in the current thread. If the of the returned is then GemBox will use or consider using WPF in the current thread; otherwise, if the value is , GemBox won't use WPF in the current thread because its Dispatcher is already shutdown. You should call this method only if you created the current thread or it is the main (primary) thread of your application. Otherwise, the thread might belong to the managed thread pool and/or the code running after your code in that thread might use WPF and therefore require a Dispatcher instance that is not shutdown. For more information, read the class remarks. A instance that must be disposed before the current thread terminates to shutdown the newly createdDispatcher and prevent the resource leak. Represents the Dispatcher instance associated with the current thread and provides a means to shut it down if it was newly created before the current thread terminates, thus preventing the resource leak. Gets a value indicating whether a Dispatcher instance associated with the current thread was created with the method call or it already existed before. if a Dispatcher instance associated with the current thread was created with the method call; otherwise, if it already existed before. The method will shutdown the Dispatcher instance associated with the current thread only if the value of this property is . Gets a value indicating a Dispatcher instance associated with the current thread is already shutdown. if a Dispatcher instance associated with the current thread is already shutdown; otherwise, . If the value of this property is then GemBox will use or consider using WPF in the current thread; otherwise, if the value is , GemBox won't use WPF in the current thread because its Dispatcher is already shutdown. Shuts down the Dispatcher instance associated with the current thread if it was newly created. The call was not made in the same thread in which the method was called. This method must be called in the same thread in which the method was called. Specifies how text shall wrap around the object's left and right sides. Specifies that text shall wrap around both sides of the object. Specifies that text shall only wrap around the left side of the object. Specifies that text shall only wrap around the right side of the object. Specifies that text shall only wrap around the largest side of the object. Represents the write protection options for the . Supported only in DOCX and DOC formats. Write protection refers to a mode in which the document's contents can be edited but the document cannot be resaved using the same file name. For more information, see DOCX Write Protection example. DOCX Write Protection example Gets or sets option that specifies if applications should provide user interface recommending that the user open this document in write protected state. if applications should provide user interface recommending that the user open this document in write protected state; otherwise, . User interface recommending that the user open this document in write protected state is only presented if password is not specified. Initializes a new instance of the class. Returns if is protected with the password against re-saving to the same file name. if is protected with the password against re-saving to the same file name; otherwise, . Clones this instance. Cloned . Sets the write protection password for the current instance. New write protection password (or to remove password from write protection). Password is optional for write protection, but without it any user will be able to open the document as not read-only and thus be able to resave the document using the same file name. Represents a class that stores loading options for XML format, currently Flat OPC XML and WordML formats are supported. Flat OPC XML file can be created in MS Word by using "Word XML Document (*.xml)" as a save format. WordML XML file can be created in MS Word by using "Word 2003 XML Document (*.xml)" as a save format. Open and read Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets or sets the password to open protected / encrypted document. The password to open protected / encrypted document. DOCX Encryption in C# and VB.NET Gets or sets the type of XML which should be imported. The value for the type of XML which should be imported. Valid XML types when importing are and . Initializes a new instance of the class. Represents a class that stores saving options for XML file. The only XML format that GemBox.Document currently supports is Flat OPC XML format. Flat OPC format. Create and write to Word file in C# and VB.NET Convert Word and HTML to PDF in C# and VB.NET Convert between Word files and HTML pages in C# and VB.NET Gets or sets the password used to protect / encrypt the document. The password used to protect / encrypt the document. DOCX Encryption in C# and VB.NET Gets or sets the saved images DPI. The saved images DPI. This property controls the image quality for all images in the file. Larger value results in better-quality images but increases the file size. Setting this property to 0 will disable image optimization. Standard DPI values are: 330 - Good quality for HD displays 220 - Good quality for most printers and displays 150 - Good quality for web pages and projectors 96 - Good quality for smaller file sizes Using this property you basically specify the DPI of the display device on which the file will be viewed and for which the images in the file should be optimized without losing any perceived quality because images go through the same resampling (reduction of pixel count) as they would in the viewer application if viewing the file using the default (100%) zoom factor on that display device. For example, if an image whose pixel size is 600px × 400px is shown on page where it occupies a slot whose physical size is 150pt × 100pt, then if the display device DPI is 144px/inch, the viewer application will show the image in a display slot whose pixel size is 300px × 200px if the default (100%) zoom factor is used (Rationale: there are always 72 points per inch and for the DPI of 144, there are 144 pixels per inch, so 150[pt] = 150[pt] × 144[px/inch] / 72[pt/inch] = 300[px]).
So the viewer application has to fit an image into a smaller display slot and it will do so by resampling the image from 600px × 400px to 300px × 200px.
Reducing the total number of pixels 4 times (from 240000 to 60000) would also reduce the image file size, so GemBox component can do this instead of the viewer application, thus achieving the overall smaller file size without any perceived loss of quality since the same image resampling would have been done by the viewer application anyway if the default (100%) zoom factor is used.
Instructing the GemBox component to perform image resampling (by setting the property to the DPI of the display device on which the file is going to be viewed) has two effects: Major benefit: output file size will be smaller if there are images whose pixel size is greater than their display size because those images are resampled to a smaller number of pixels without any perceived loss of quality since the same resampling would have been done by the viewer application anyway. Minor benefit: viewer application will be able to present the image faster because it needs to decode a fewer number of pixels and because the display slot size will be exactly equal to the image pixel size so it doesn't have to perform any resampling if the default (100%) zoom factor is used. Initializes a new instance of the class. Gets the content-type for XML file format: application/xml. The content-type for XML file format. Defines the type of XML. Flat OPC format (Word XML Document). WordML format (Word 2003 XML Document).