Documents for Word, .NET Edition Documentation
GrapeCity.Documents.Word Assembly / GrapeCity.Documents.Word Namespace
Inheritance Hierarchy
In This Topic
    GrapeCity.Documents.Word Namespace
    In This Topic
    Classes
     ClassDescription
    Class Represents a collection of alternative style names.
    Class Override bidirectional behavior of children text.
    ClassRepresents a collection of BidirectionalOverride objects.
    Class Represents the body of a document or other content containers.
    Class Represents a bookmark range in a body content.
    ClassRepresents a collection of Bookmark elements.
    Class Represents a bookmark end mark element in a body content.
    Class Represents a bookmark start mark element in a body content.
    Class Represents a border of an object.
    ClassRepresents a collection of Borders for the four sides of an object.
    Class Represents a break element in a body content.
    Class Represents a building block in a document. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting.
    Class Represents a collection of building blocks.
    Class Represents built-in document properties.
    ClassThe exception that is thrown when trying to set a property for ListLevel with ListLevel.NumberStyle equals NumberStyle.Bullet.
    Class Specifies the categorization for a building block. This categorization shall not imply any behaviors around the building block, and is only used to organize the set of building blocks within an application or user interface i.e. to disambiguate between two building blocks with the same entry name.
    Class Represents a table cell element in a body content.
    Class Represents the set of borders for the edges of a cell.
    ClassRepresents a collection of Cell objects.
    Class Represents formatting for a table cell.
    Class Represents a set of table cell paddings.
    Class Specifies a symbol to be used for a checkbox state.
    Class Represents the color scheme of a Microsoft Office theme. The color scheme is responsible for defining a list of twelve colors. The twelve colors consist of six accent colors, two dark colors, two light colors and a color for each of a hyperlink and followed hyperlink.
    Class Represents a comment range in a body content.
    ClassRepresents a collection of Comment elements.
    Class Represents a comment end mark element in a body content.
    ClassRepresents an annotation reference mark at the current location in the comment.

    An annotation reference mark is an information block that represents the metadata associated with the current comment. The annotation reference mark should typically consist of the initials and a unique integer associated with its position in the document, but can be displayed in any desired format.

    Class Represents a comment content reference mark that links the comment content with the contents of a document story.
    Class Represents a comment start mark element in a body content.
    Class Contains compatibility options.
    Class Represents a complex field element in a body content.
    ClassRepresents a collection of ComplexField objects.
    Class ComplexField copy-related exception
    Class Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style.
    ClassRepresents a collection of ConditionalStyle objects.
    Class The exception that is thrown when trying to insert a child content into a content that cannot have children.
    Class Represents a collection of content items.
    Class An individual content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as dates, lists, or paragraphs of formatted text.
    ClassRepresents a collection of ContentControl items.
    Class Specifies the set of properties applied to the mark present to delimit the end of the control contents.
    ClassRepresents a mark (start or end) for ContentRange objects like bookmarks or comments. Derived classes include CommentStart, CommentEnd, CommentReference, BookmarkStart, BookmarkEnd, FieldChar, GrapeCity.Documents.Word.EditableRangeStartand GrapeCity.Documents.Word.EditableRangeEnd.
    Class The exception that is thrown when trying to copy a none-cloneable content.
    Class The exception that is thrown when trying to split a non-splittable content.
    ClassBase class representing a content object in a document.

    Derived classes include FormattedContentObject, ContentMark, Text, UnknownContent, CommentInfo, SeparatorMark, ContinuationSeparatorMark, Footnote, Endnote, EndnoteReferenceMark, FootnoteReferenceMark, Hyperlink, SimpleField, ControlContent, SectionBreak, ShapeBase, TextFrame, LinkedTextFrame.

    ClassRepresents a collection of ContentObject.
    ClassAbstract base class representing content with floating start and end marks. This allows the range to start inside one ContentObject and end in another, which is useful for bookmarks, comments etc.

    Derived classes include Section Comment, Bookmark, ComplexField and EditableRange.

    ClassRepresents a collection of ContentRange elements.
    ClassRepresents a continuation separator mark within a run.

    A continuation separator mark is a horizontal line that spans the width of the main story's text extents. The continuation separator mark is typically used within the context of continuation separator footnotes or endnotes. These footnote and endnote types define the footnote/endnote used to separate the contents of the main document story from continuation of footnotes or endnotes that began on a previous page.

    ClassProvides access to the content of a ContentControl.
    Class Copy range of objects into another range.
    Class A collection of custom document properties.
    Class Represents a custom XML data storage in the document.
    ClassRepresents a collection of CustomXmlPart objects in the document.
    Class The exception that is thrown when trying to modify default paragraph style properties.
    ClassThe base class for GcWordDocument and GlossaryDocument classes.
    Class Represents a document property.
    ClassBase class for the CustomPropertyCollection and BuiltInPropertyCollection
    Class Represents the set of document protection restrictions applied to a document.
    Class Represents a dropped capital letter at the beginning of a paragraph.
    Class Specifies a single list item within the content control. Each list item shall be displayed in the list displayed for the content control (if a user interface is present).
    ClassRepresents a list of DropDownItem objects.
    Class Specifies any East Asian typography settings which shall be applied to the contents of a run.
    Class Provides options for East Asian typography.
    Class Represents additional extent to each edge of an object.
    Class Class that define modifiable region of document and user/group allowed to modify it when document protection is on
    ClassRepresents a collection of EditableRange elements.
    Class Represents the edit protection settings of a document.
    Class Represents an endnote.
    ClassRepresents a collection of Endnote objects.
    Class Represents the endnote numbering options for a document or section.
    ClassRepresents an endnote reference mark.

    A endnote reference mark is a run of automatically numbered text that follows the numbering format specified via the EndnoteOptions.NumberStyle.

    ClassRepresents a complex field character at a location in the parent run.

    A complex field character is a special character that delimits the start and end of a complex field, or separates its field codes from its current field result.

    Class Represents a field code within a complex field in a document.
    ClassRepresents a collection of FieldCode objects.
    Class Represents the formatting criteria for a find operation.
    Class Represents options for a find operation.
    Class The exception that is thrown when FindReplace cannot process replace request.
    Class Represents options for a find and replace operation.
    Class Represents the result of a find operation.
    Class Represents font attributes (font name, size, color, and so on) for an object.
    Class Contains font attributes (font name, font size, color, and so on) for an object.
    ClassRepresents a font scheme within a theme.

    The font scheme consists of a pair of major and minor fonts for which to use in a document. The major font corresponds well with the heading areas of a document, and the minor font corresponds well with the normal text or paragraph areas.

    Class Represents a footnote positioned at the bottom of the page or beneath text.
    ClassRepresents a collection of Footnote objects.
    Class Represents the footnote numbering options for a document or section.
    ClassRepresents a footnote reference mark.

    A footnote reference mark is a run of automatically numbered text that follows the numbering format specified via the FootnoteOptions.NumberStyle.

    ClassRepresents a ContentObject that has formatting properties.

    Derived classes include Paragraph, Run, Table, Row, Cell, ContentControl.

    Class Specifies the set of properties applied to the the special content mark.
    Class Abstarct class that provides base functionality to store and resolve formatting in objects.
    ClassRepresents a Word document.

    Contains one or more sections, content controls, and body representing the content of the document.

    Class A supplementary document storage which stores the definition and content for content that shall be carried with the document for future insertion and/or use, but which shall not be visible within the contents of the main document story.
    Class Specifies an alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this range of the document. This mechanism simply provides a set of predefined editing groups which can be associated with user accounts by applications in any desired manner.
    Class Represents a single header that shall be associated with a section in the document.
    ClassRepresents a collection of HeaderFooter objects in a section. Section may contain every type of HeaderFooterType HeaderFooter(
    Class Represents a hyperlink element in a body content.
    ClassRepresents a collection of Hyperlink objects.
    Class Allows to configure document hyphenation options.
    Class Represents image data for a picture.
    Class Represents the set of indentation properties applied to a paragraph.
    Class The exception that is thrown when trying to insert invalid content control type inside the content control.
    Class The exception that is thrown when trying to insert invalid content type inside the content control.
    Class The exception that is thrown when trying to insert invalid content type inside the specific level content control.
    Class The exception that is thrown when trying to insert invalid content type into the specific parent content inside inside the specific level content control.
    Class The exception that is thrown when trying to insert invalid content type into the specific parent content inside the content control.
    Class The exception that is thrown when trying to insert more then one characters inside the content control.
    Class The exception that is thrown when trying to insert more then one content of the specific type inside the content control.
    Class The exception that is thrown when trying to set properties that the current content control is not supported.
    Class The exception that is thrown when trying to insert content into an invalid position.
    Class The exception that is thrown when trying to insert a content object into a non-allowed parent content.
    Class The exception that is thrown when trying to get a range from an invalid position.
    Class The exception that is thrown when trying to split content on an invalid position.
    Class The exception that is thrown when trying to set a property value.
    Class Represents the position delimited the end of a page when this document was last saved by an application which paginates its content.
    Class Represents settings for line numbering to be displayed before each column of text in the section.
    Class Represents a text frame that participates in a text frame story.
    Class list formatting for a paragragh.
    Class Represents a single list level, either the only level for a bulleted or numbered list or one of the nine levels of an outline numbered list.
    Class Represents a collection of list formatting for each level in a list.
    Class Represents a single list template that includes all formatting that defines a list.
    Class Stores and manages formatting of bulleted and numbered lists used in a document.
    ClassRepresents a marker pointing to a position in a document relative to a specific ContentObject.

    The marker can point to a position at the start of an object (MarkerType.Start, at the end of an object (see MarkerType.End, or to a position occupied by a whole childless object (MarkerType.Whole.

    If the marker belongs to a PersistentRange, it can be used even if its ContentObject has been deleted.

    Class Represents the details of a match.
    Class The exception that is thrown when content objects cannot be merged one into another.
    Class Specifies how document is printed out.
    ClassException that is thown if the current shape WrapType does not support this property.
    Class Represents the page borders for all pages in a section.
    Class Represents the settings for a page grid, which enables precise layout of full-width East Asian language characters within a section by specifying the desired number of characters per line and lines per page for all East Asian text content in section.
    Class Represents the page margins for all pages in a section.
    Class Represents page numbering settings for all page numbers that appear in the contents of a section.
    Class Represents a page setup. This object exposes all page setup attributes (page margin, paper size, and so on) as properties.
    Class Represents page size and orientation for all pages in a section.
    Class Represents a printer paper source.
    Class Represents a paragraph element in a body content.
    Class Specifies the borders for a paragraph.
    ClassRepresents a collection of Paragraph objects.
    Class Contains FindReplace extension methods for RangeBase class.
    Class Represents all formatting for a paragraph.
    Class Specifies the set of properties applied to the glyph used to represent the physical location of the paragraph mark for this paragraph. This paragraph mark, being a physical character in the document, can be formatted, and therefore shall be capable of representing this formatting like any other character in the document.
    Class Represents a unique identifier used to track paragraph editing sessions.
    Class Represents a password used to protect a document.
    ClassRepresents a contiguous area of content objects in a document. Unlike Range, PersistentRange is kept alive and can be used even if the content used to create this range has been deleted.

    Importnant: to avoid performance degradation, you should dispose PersistentRange when it is no longer needed.

    Class Represents a picture element in a body content.
    Class Represents the appearance and behavior of a specific picture to be used as the numbering symbol within a numbering level definition in a document.
    ClassRepresents a collection of PictureBullet objects.
    ClassRepresents a collection of Picture objects.
    Class Represents a value and its unit of measurement that is used to specify the preferred width of a table or a cell.
    Class The exception that is thrown when trying to set null or white spaces value to a property.
    ClassRepresents a contiguous area of content objects in a document.

    See also PersistentRange.

    ClassBase class for Range and Body that allows to manipulate content in a document.
    ClassProvides find/replace extension methods for the RangeBase class.
    ClassRepresent individual EditableRange access holder.
    Class Represents a text range that replaced a search text.
    Class Represents the details about a found text.
    Class Represents a unique identifier used to track editing sessions.
    Class Represents a table row element in a body content.
    ClassRepresents a collection of Row objects.
    Class Represents formatting for a table row.
    Class Represents a unique identifier used to track table row editing sessions.
    ClassRepresents a contiguous fragment of a body content with uniform formatting.

    Use ContentObject.GetRange to access the range of objects inside a run.

    ClassRepresents a collection of Run objects.
    Class Represents a unique identifier used to track run editing sessions.
    Class Represents a section element in a body content.
    Class Represents a section break in a body content.
    ClassRepresents a collection of Section objects.
    Class Represents a unique identifier used to track section editing sessions.
    ClassRepresents a separator mark within the current run.

    A separator mark is a horizontal line that spans part of the width text extents. The separator mark is typically used within the context of separator footnotes or endnotes. These footnote and endnote types define the footnote/endnote used to separate the contents of the main document story from the contents of footnotes or endnotes on that page.

    Class Represents options that control protection, view, compatibility and other settings.
    Class Contains shading attributes for an object.
    Class Represents a shape element in a body content.
    ClassBase class for all types of shapes, including Shape and Picture. It also represents currently unsupported shape types such as charts, groups, canvas etc.
    ClassRepresents a collection of Shape objects.
    Class Specifies a shape height.
    Class Represents the horizontal positioning of a floating shape within a document.
    Class Represents the properties used for positioning a shape in the document.
    Class Represents rotation properties of a shape.
    Class Specifies a shape size.
    Class Represents the vertical positioning of a floating shape within a document.
    Class Specifies a shape width.
    Class Represents a simple field element in a body content.
    ClassRepresents a collection of SimpleField objects.
    Class Specifies the set of indentation properties applied to the current paragraph.
    Class Represents a built-in or user-defined style.
    Class Represents a collection of built-in and user-defined styles in a document.
    Class Represents a symbol element in a body content.
    Class Represents an absolute position tab element in a body content.
    Class Represents a table element in a body content.
    Class Represents the set of borders for the edges of the table.
    ClassRepresents a collection of Table objects.
    Class Represents formatting of a table.
    Class Represents base formatting for a table.
    Class Represents the horizontal positioning of a floating table within a document.
    Class Represents information about the current table with regard to floating tables. Floating tables are tables in a document which are not part of the main text flow in the document, and are instead absolutely positioned with a specific size and position relative to non-frame content in the current document.
    Class Represents a style that can be applied to a table.
    Class Represents base properties that can be applied to a table.
    Class Specifies the vertical positioning of a floating table within a document.
    Class Represents a single custom tab stop.
    ClassRepresents a collection of TabStop objects that define custom tabs for a paragraph or a style.
    ClassRepresents a text element in a body content.

    A Text belongs to a single Run, which determines its formatting. Derived classes include FieldCode, Break, Symbol, Tab and LastRenderedPageBreak.

    ClassRepresents a collection of Text objects.
    Class Represents a single text column.
    ClassRepresents a collection of TextColumn objects that represent all columns of text in a section.
    ClassRepresents the text content of a Shape and associates that textual information, referred to as a text frame story, with a story identifier.
    ClassRepresents a collection of TextFrame objects.
    Class Represents the format of a text frame.
    Class Holds all formatting options available to a document through a theme and defines the overall look and feel of the document when themed objects are used within the document.
    Class Represents a color in the color scheme of a theme.
    Class Represents a font that is to be used for a specific language or locale.
    Class Represents a set of fonts that are to be used for different languages or locales.
    Class Represents content of a type that is not supported by GcWord. Such objects are handled as black boxes by GcWord, they are preserved in the document, but cannot be modified.
    ClassRepresents a collection of UnknownContent items.
    Class Specifies a single user for which this range permission shall be enabled (i.e. a user which shall be able to edit this range when document protection is enabled). This editor can be stored in one of the following forms: DOMAIN\username - for users whose access shall be authenticated using the current user's domain credentials user@domain.com - for users whose access shall be authenticated using the user's e-mail address as credentials user - for users whose access shall be authenticated using the current user's machine credentials
    Class Represents a variable stored as part of a document. Document variables are used to preserve macro settings in between macro sessions.
    ClassA collection of Variable objects that represent the variables added to a document or template. Document variables are used to preserve macro settings in between macro sessions.
    Class Provides various options that control how a document is shown in application.
    ClassRepresents the color of a one-color object or the foreground or background color of an object with a gradient or patterned fill. You can set colors to an explicit red-green-blue value by using the RGB property.
    Class Represents the properties for wrapping text around a shape or shape range.
    Class Specifies the information which shall be used to establish a mapping between a content control and an XML node stored within a Custom XML Data part in the document.
    Interfaces
     InterfaceDescription
    Interface Defines methods to access previous and next items in a collection.
    Interface Defines methods to access the first and last items in a collection.
    Enumerations
     EnumerationDescription
    Enumeration specifies the vertical alignment of all text on each line displayed within a paragraph.
    Enumeration Defines Left-to-right or Right-to-left text visualization mode.
    Enumeration Specifies the types of a body.
    EnumerationSpecifies the location that shall be used as the next available line when the Break.Type has a value of BreakType.TextWrapping. This value only affects the restart location when the current run is being displayed on a line that does not span the full text extents due to the presence of a floating object.
    EnumerationSpecifies the type of a break.

    The break type determines the next location where text shall be placed after this manual break is applied to the text contents.

    Enumeration Specifies a building block gallery.
    Enumeration Specifies how a building block is inserted into a document.
    Enumeration Specifies the type of a building block. influence the visibility and behavior of the building block.
    Enumeration Specifies predefined list templates available in Microsoft Word.
    Enumeration Specifies Microsoft Word buit-in style identifiers.
    Enumeration Specifies the calendar type.
    Enumeration Specifies how a cell in a table is merged with other cells.
    Enumeration Specifies vertical justification of text inside a table cell.
    Enumeration Specifies the separator character that appears between the chapter and page number, if a chapter style has been set for page numbers in a section.
    Enumeration Specifies the appearance of a content control.
    Enumeration Specifies the layout level of the content control.
    Enumeration Specifies the type of content control.
    Enumeration Specifies the specific cryptographic hashing algorithm which shall be used along with the salt property and user-supplied password in order to compute a hash value for comparison.
    Enumeration Specifies the date translation which shall be applied to the date content control.
    Enumeration Specifies the possible values for the location of a single custom XML element's start and/or end tag relative to the location of an annotation tag in document order.
    Enumeration Used as a value for the Security property. Specifies the security level of a document as a numeric value.
    Enumeration Defines the Word document type.
    Enumeration Specifies the position of a drop cap text.
    Enumeration The edGrp attribute value of editors specifies that only user(s) who the current application associates with the editors group must be allowed to edit the contents between the start and end markers when document protection is being enforced.
    Enumeration Specifies the type of protection applied to a document.
    Enumeration Specifies the emphasis mark for a character or designated character string.
    Enumeration Defines the endnote position.
    Enumeration Determines when automatic endnote numbering restarts.
    Enumeration Specifies the type of a complex field character in a document.
    Enumeration Specifies information used to decide how to format any characters in the current run for which the font type is otherwise ambiguous.
    Enumeration Defines the footnote or endnote position.
    Enumeration Determines when automatic footnote numbering restarts.
    Enumeration Defines how to copy object style
    Enumeration Specifies where the gutter appears in the document.
    Enumeration Specifies the type of a header or footer.
    Enumeration Specifies the rule for determining the height of an object.
    Enumeration Specifies a highlighting color which is applied as a background behind the contents.
    Enumeration Specifies the compression state used to store a picture. This allows an application to specify the amount of compression that has been applied to a picture.
    Enumeration Determines the position where to insert a new content into a specified content.
    Enumeration Specifies how full-width characters in the current document should be compressed to remove additional whitespace when the contents of this document are displayed, specifically by specifying the set(s) of characters which can be compressed to remove additional whitespace.
    Enumeration Specifies how text is laid out in the layout grid for a section.
    Enumeration Specifies the type of ligatures applied to a font.
    Enumeration Specifies when automatic line numbering restarts.
    Enumeration Specifies line spacing values for a paragraph.
    EnumerationSpecifies the line style of a Border.
    Enumeration Specifies alignment for a list number or bullet.
    Enumeration Specifies the character that separates the list label from the text of the paragraph.
    Enumeration Specifies the result of comparing two range locations.
    EnumerationSpecifies the type of a Marker.
    Enumeration Specifies how document is printed out.
    Enumeration Specifies the number form setting for an OpenType font.
    Enumeration Specifies the number spacing setting for an OpenType font.
    Enumeration Specifies the number style for lists, footnotes, endnotes and page numbers.
    Enumeration Specifies the outline level of a paragraph in the document.
    Enumeration Specifies which pages the page border is printed on.
    Enumeration Specifies the element from which a page border position is measured.
    Enumeration Specifies page orientation.
    Enumeration Specifies paper size.
    Enumeration Specifies a printer paper tray.
    Enumeration Specifies text alignment in a paragraph.
    Enumeration Specifies the result of a password validation.
    Enumeration Specifies the unit of measurement for the preferred width of a table or cell.
    Enumeration Specifies data type of a document property.
    EnumerationDetermines the position where to insert a new ContentRange or get a part of the specified range.
    Enumeration Specifies the action to take when a match is found.
    Enumeration Specifies the type of break at the beginning of a section.
    Enumeration Specifies the relative horizontal alignment position of a shape.
    Enumeration Specifies the element relative to which the horizontal position of an object is defined.
    Enumeration Specifies how the shape position is calculated.
    Enumeration Specifies the relative vertical alignment position of a shape.
    Enumeration Specifies to what the vertical position of an object is relative.
    Enumeration Specifies the relative width type of a shape.
    Enumeration Specifies the relative height type of a shape.
    Enumeration Specifies the type of a style.
    Enumeration Specifies a style's visiblity in application user interface.
    Enumeration Specifies a list of stylistic sets that modify the display of OpenType fonts.
    Enumeration Specifies the location of a positional tab stop on a line, as well as the alignment that shall be applied to text subsequent to the current positional tab stop.
    Enumeration Specifies the character that shall be used to fill in the space created by a positional tab. This character shall be repeated as required to completely fill the tab spacing generated by the positional tab character.
    Enumeration Specifies alignment for an inline table.
    Enumeration Specifies the relative horizontal alignment position of the table.
    Enumeration Specifies to what the horizontal position of an object is relative.
    Enumeration Specifies how the table position must be calculated.
    Enumeration Specifies how table style is applied to a table.
    Enumeration Specifies the area of a table to which special style formatting is applied.
    Enumeration Specifies the relative vertical alignment position of the table.
    Enumeration Specifies to what the vertical position of an object is relative.
    Enumeration Specifies the extents that shall be used to calculate the absolute positioning of a positional tab character.
    Enumeration Specifies the alignment type of a tab stop.
    Enumeration Specifies the type of the leader line displayed under the tab character.
    Enumeration Specifies animation effect for text runs.
    Enumeration Specifies the lines in the paragraph that shall allow the text to be tight wrapped to the paragraph (and not the text box) extents when displaying the document.
    Enumeration Specifies the text flow and reading order of the content.
    Enumeration Specifies text orientation.
    Enumeration Specifies shading texture.
    Enumeration Specifies the available vertical anchoring types for text.
    Enumeration Specifies the preset text shape geometries that can be used for a text frame.
    Enumeration Specifies the theme colors for document themes.
    Enumeration Specifies the theme colors for document themes.
    Enumeration Specifies a theme font type that can be referenced as a theme font. This theme font is a reference to one of the predefined theme fonts, located in the document, which allows for font information to be set centrally in the document.
    Enumeration Specifies that the two lines in one text should be enclosed within a pair of brackets when displayed. This enum values determine the bracket style to put around combined text.
    Enumeration Specifies the type of the underline applied to a font.
    Enumeration Specifies the type of vertical alignment to apply.
    Enumeration Specifies the vertical text position.
    Enumeration Possible values for the view mode in application.
    Enumeration Specifies a relationship between a content control and an Office Web Extension.
    Enumeration Defines the Microsoft Word version.
    Enumeration Specifies how text wraps around the sides of a shape. Specifies whether the document text should wrap on both sides of the shape, on either the left or right side only, or on the side of the shape that is farthest from the page margin.
    Enumeration Specifies the wrap type of a shape.
    Enumeration Possible values for how large or small the document appears on the screen in the application.
    See Also