Infragistics4.WebUI.Documents.Word.v12.2 Contains the anchored content for the associated Paragraph.

A picture which is anchored to a specific location within the document can be added to the paragraph using the AddAnchoredPicture method.

A shape which is anchored to a specific location within the document can be added to the paragraph using the AddAnchoredShape method.

Text, hyperlinks, images, and shapes can be added to a paragraph using the ContentRuns collection. Content which belongs to this collection does not occupy a static location within the document, but rather changes position as other content is added or removed.

ContentRunsCollection class ContentRuns collection (Paragraph class) Base class for collections. Removes all elements from this collection. Removes the item at the specified ordinal position within this collection. The ordinal position of the item to remove. Removes the specified from this collection. The item to remove. Adds the specified to this collection. The item to add. Inserts the specified into this collection at the specified The item to add. The ordinal position at which to add the item. Returns the index of the specified within this collection, or -1 if the item is not a member of this collection. The item to locate. Returns a boolean value indicating whether the specified is contained within this collection. The item to test. Returns the string representation of this object. Returns the object at the specified ordinal position within this collection. The zero-based ordinal position of the item within this collection. The object at the specified ordinal position. Returns the number of elements in this collection. Returns the Document with which this collection is associated. Adds an AnchoredPicture to the associated paragraph. The image displayed by the picture. Adds an AnchoredPicture to the associated paragraph. The AnchoredPicture instance to be added. Inserts an AnchoredPicture into the associated paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. The image displayed by the picture. Inserts an AnchoredPicture into the associated paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. The AnchoredPicture instance to be added. Adds an AnchoredShape to the associated paragraph. A ShapeType constant which defines the type of shape to be added, i.e., a line, rectangle, ellipse, etc. Adds an AnchoredShape to the associated paragraph. A VmlShape instance which defines the properties of the shape to be added. Adds an AnchoredShape to the associated paragraph. The AnchoredShape instance to be added. Inserts an AnchoredShape into the associated paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. A ShapeType constant which defines the type of shape to be added, i.e., a line, rectangle, ellipse, etc. Inserts an AnchoredShape into the associated paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. A VmlShape instance which defines the properties of the shape to be added. Inserts an AnchoredShape into the associated paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. A AnchoredShape instance which defines the type of shape to be added, i.e., a line, rectangle, ellipse, etc. Encapsulates a block of content within a Document such as a Paragraph or Table.

Creates a new instance of the class. The Document with which this instance is associated. Returns the ordinal position of this item within the collection to which it belongs, or -1 if it does not belong to a collection. Returns the Document associated with this instance. Contains the block-level content (i.e., paragraphs and tables ) for a Document, TableCell, header, or footer. Adds a Paragraph to this collection. A reference to the Paragraph that was added. Inserts a Paragraph at the specified ordinal position within this collection. The ordinal position within this collection at which to insert the paragraph. A reference to the Paragraph that was added. Adds a Table to this collection. A reference to the Table that was added. Inserts a Table at the specified ordinal position within this collection. The ordinal position within this collection at which to insert the paragraph. A reference to the Table that was added. Returns an enumerator which includes only the paragraphs which belong to this collection. Returns an enumerator which includes only the tables which belong to this collection. Contains the inline content for the associated Paragraph, such as text, hyperlinks, inline pictures, and inline shapes.

A run of text can be added to the paragraph using the AddTextRun method.

A hyperlink can be added to the paragraph using the AddHyperlink method.

A picture which appears inline with textual content can be added to the paragraph using the AddInlinePicture method.

A shape which appears inline with textual content can be added to the paragraph using the AddInlineShape method.

"Inline" content is defined as content whose position within the document changes dynamically as other content is added to or removed from the document. The ContentRunsCollection class is the container for all such content.

Pictures and Shapes which are anchored to a specific location within the document can be added to a paragraph using the Anchors collection.

AnchorsCollection class Anchors collection (Paragraph class) Adds a new line to the associated paragraph. Adds a new line to the associated paragraph. A NewLineType constant which determines the way the newline character is represented in the generated output. Adds a TextRun to the associated Paragraph. The text to be added. A TextRun instance. Adds a TextRun to the associated Paragraph. The text to be added. A Font instance which defines the formatting attributes for the resulting run of text. A TextRun instance. Adds a TextRun to the associated Paragraph. The text to be added. A Font instance which defines the formatting attributes for the resulting run of text. Specifies whether the content is proofed for spelling and grammatical errors. A TextRun instance. Adds the specified TextRun The TextRun instance to add. Adds a TextHyperlink to the associated Paragraph. The address for the hyperlink. Must be a valid URI. The text displayed for the hyperlink. In the absence of an explicit value, the is displayed. A TextHyperlink instance. Adds a TextHyperlink to the associated Paragraph. The address for the hyperlink. Must be a valid URI. The text displayed for the hyperlink. In the absence of an explicit value, the is displayed. The text that is displayed when the user hovers the cursor over this hyperlink. A TextHyperlink instance. Adds a TextHyperlink to the associated Paragraph. The address for the hyperlink. Must be a valid URI. The text displayed for the hyperlink. In the absence of an explicit value, the is displayed. The Font which defines the formatting attributes for the text that is displayed. A TextHyperlink instance. Adds a TextHyperlink to the associated Paragraph. The address for the hyperlink. Must be a valid URI. The text displayed for the hyperlink. In the absence of an explicit value, the is displayed. The Font which defines the formatting attributes for the text that is displayed. The text that is displayed when the user hovers the cursor over this hyperlink. A TextHyperlink instance. Adds a TextHyperlink to the associated Paragraph. The address for the hyperlink. Must be a valid URI. A list of TextRun instances which define the rich content for the hyperlink. The text that is displayed when the user hovers the cursor over this hyperlink. A TextHyperlink instance. Adds the specified TextHyperlink to the associated Paragraph. The TextHyperlink instance to add. Adds an InlinePicture to the associated Paragraph. The image associated with the inline picture to be added. An InlinePicture instance. Adds an InlinePicture to the associated Paragraph. The image associated with the inline picture to be added. The size at which the picture is displayed. Specify null to use the natural size of the associated . An InlinePicture instance. Adds the specified InlinePicture to the associated Paragraph. The InlinePicture instance to add. Adds an InlineShape to the associated Paragraph. A ShapeType constant which defines the type of shape to be added, i.e., a line, rectangle, ellipse, etc. An InlineShape instance. Adds an InlineShape to the associated Paragraph. A ShapeType constant which defines the type of shape to be added, i.e., a line, rectangle, ellipse, etc. The size at which the shape is displayed. In the absence of an explicit value, the shape is displayed at a size of one inch square. An InlineShape instance. Adds the specified InlineShape to the associated Paragraph. The InlineShape instance to add. Adds the specified InlineShape to the associated Paragraph. The VmlShape instance to add. Adds a PageNumberField to the associated Paragraph. A PageNumberFieldFormat constant which defines the format for the page number field. A PageNumberField instance.

Note: Page number fields are only supported for content which appears within a header or footer. Attempting to add a page number field to content which appears within the main document part will cause an exception to be thrown.

Inserts a TextRun into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the text run. The text to be added. A TextRun instance. Inserts a TextRun into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the text run. The TextRun to be added. Inserts a TextHyperlink into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the hyperlink. The address for the hyperlink. A TextHyperlink instance. Inserts a TextHyperlink into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the hyperlink. The address for the hyperlink. Must be a valid URI. The text displayed for the hyperlink. In the absence of an explicit value, the is displayed. A TextHyperlink instance. Inserts a TextHyperlink into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the hyperlink. The TextHyperlink instance to insert. Inserts an InlinePicture into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. The image associated with the inline picture to be added. An InlinePicture instance. Inserts an InlinePicture into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the picture. The InlinePicture instance to insert. Inserts an InlineShape into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the shape. A ShapeType constant which defines the type of shape to be added, i.e., a line, rectangle, ellipse, etc. An InlineShape instance. Inserts an InlineShape into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the shape. The InlineShape instance to insert. Inserts a PageNumberField into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the text run. A PageNumberFieldFormat constant which defines the format for the page number field. A PageNumberField instance.

Note: Page number fields are only supported for content which appears within a header or footer. Attempting to add a page number field to content which appears within the main document part will cause an exception to be thrown.

Inserts the specified PageNumberField into the associated Paragraph at the specified ordinal position. The ordinal position within this collection at which to insert the page number field. The PageNumberField instance to insert.

Note: Page number fields are only supported for content which appears within a header or footer. Attempting to add a page number field to content which appears within the main document part will cause an exception to be thrown.

Encapsulates a word processing document.

The Document class represents the root level of the object hierarchy. It serves as a container for block-level content such as paragraphs and tables.

Block-level content is contained within the ContentBlocks collection; paragraphs and tables can be added to a document using the AddParagraph and AddTable methods, respectively.

Properties of the document such as author, title, and subject can be specified using the DocumentProperties property.

Default formatting attributes for all content within the document can be defined using the DefaultFont, DefaultParagraphProperties, and DefaultTableProperties properties.

Pagination properties such as page size, page orientation, and margins, can be defined using the FinalSection property and the Sections collection. The FinalSection property returns an object with which the developer can specify pagination properties for the entire document. The Sections collection provides a way to define document sections for groups or block-level content. When the Sections collection contains one or more members, the FinalSection defines the pagination for the block-level content in the document which follows the last block for which a section is explicitly defined.

Headers and footers can also be added to the document, using the HeaderAllPages, FooterAllPages, HeaderFirstPageOnly, and FooterFirstPageOnly properties of the section. Headers and footers can contain the same block-level content as the document itself; content is written to the headers/footers using the identical syntax as is used when writing main document content (headers and footers expose a ContentBlocks collection, which is the same type as the ContentBlocks collection exposed by the Document).

The developer can use the Unit property to change the implied unit of measurement for the property get and set methods at any time during the lifetime of the document without affecting the actual values. For example, when setting font sizes the property can be set to 'Point', and then changed to 'Inch' or 'Centimeter' when setting indentation or line spacing, and any previously set values will remain as they were.

The default file extension for documents produced by this class ("docx"). The default value for the Unit property (Point). Creates a new instance of the class. Returns a new Font for use within this Document. Returns a new TextRun for use within this Document. The text for the run. Returns a new TextHyperlink for use within this Document. The address of the hyperlink. Must be a valid URI. The text displayed for the hyperlink. If null, the is displayed. Returns a new InlinePicture for use within this Document. The image associated with the picture. Returns a new AnchoredPicture for use within this Document. The image associated with the picture. Returns a new InlineShape for use within this Document. A ShapeType constant which defines the type of shape, i.e., a line, rectangle, ellipse, etc. Returns a new InlineShape for use within this Document. A previously created VmlShape instance which defines the properties of the shape. Returns a new AnchoredShape for use within this Document. A ShapeType constant which defines the type of shape, i.e., a line, rectangle, ellipse, etc. Returns a new AnchoredShape for use within this Document. A previously created VmlShape instance which defines the properties of the shape. Returns a new VmlShape for use within this Document. A ShapeType constant which defines the type of shape, i.e., a line, rectangle, ellipse, etc. Saves the contents of the document to a file in the MS Word2007 document format. The complete path to the destination file. Note that if the file extension is omitted, the DefaultFileExtension is used.

The output produced by this method can be consumed by a WordprocessingML that supports the MS Word2007 format, or an application which supports the WordProcessingML specification.

Exports the contents of this Document to the specified . Restores all property values to their respective defaults, and clears the contents of all collections. Returns the string representation of this instance. Returns a collection of ContentBlock-derived objects, such as paragraphs or tables, which comprise the block-level content for this document. AddParagraph method AddTable method Returns an object which contains information about this Document such as title, author, subject, etc. DocumentProperties class Returns a boolean value indicating whether the object returned from the DocumentProperties property has been created, and whether any of its properties are set to non-default values. Returns Font object which applies to all characters in this document with no more specific setting.

The properties of the instance returned by this property define the font attributes for all text runs within the document which do not have a font explicitly defined.

Returns a ParagraphProperties instance which defines the properties for paragraphs which do not have properties explicitly defined. Properties property (Paragraph class) Returns a boolean value indicating whether the object returned from the DefaultParagraphProperties property has been created, and whether any of its properties are set to non-default values. Returns a DefaultTableProperties instance which defines the properties for tables which do not have properties explicitly defined. DefaultTableProperties class Properties property (Table class) Returns a boolean value indicating whether the object returned from the DefaultTableProperties property has been created, and whether any of its properties are set to non-default values. Returns a DocumentFinalSection instance which defines properties such as page size, margins, and orientation for the final section of the document.

The instance returned from this property defines the pagination for all content in the document that does not belong to a section.

In the case where no sections are defined for any paragraph or table in the document, this property defines the pagination for the entire document.

Returns or sets a value which determines the method used to represent a newline in the generated output.

The newline character(s) can be represented as either a line break or a carriage return. A document consumer may interpret a line break or carriage return differently depending on the circumstances under which it is used. For example, paragraph justification can behave differently in MS Word depending on whether a line break is contained within the paragraph. A carriage return is recognized in a standard paragraph as a line-breaking character, but is not recognized when the paragraph is contained within a table cell.

This property can be used to specify the method used to represent a newline for all text runs within the document. The AddNewLine method overload which takes a NewLineType parameter can be used to generate a newline character independently of the value of this property. The TextRun class also exposes a NewLineType property, so that the newline character can be specified on a per-TextRun basis.

Returns a collection of Section instances which define the pagination for specific parts of the document.

The The Sections collection provides a way to define sections for a range of ContentBlocks, rather than for the entire document. For example, if a member is added to the Sections collection for the third paragraph in a document, the pagination for that section applies to the first three paragraphs in the document. Pagination for the remainder of the content in the document is then defined by the FinalSection.

Each member of the Sections collection defines pagination for the content block with which it is associated, and the content blocks which precede it. For example, if one section is defined for the third paragraph in the document, and another one for the fifth, pagination for paragraphs four and five are defined by the second section, and pagination for paragraphs one, two, and three by the first one. Pagination for all paragraphs following the fifth one in this case is defined by the FinalSection.

FinalSection property Section class Returns or sets a value indicating the implied unit of measurement for properties which represent graphical quantities.

The default unit of measurement for the properties which represent graphical quantities is the desktop publishing point, which is equivalent to 1/72 of an inch. This property can be changed to redefine that unit of measurement, so that graphical properties can be interacted with using units that are most comfortable to the end developer.

All property values are stored internally as twips (twentieths of a point), and coverted as appropriate in the property's get and set method implementations. The value of the Unit property can be changed at any time by the developer without affecting previously persisted property values.

Base class for headers and footers.

Returns a collection of ContentBlock-derived objects, such as paragraphs or tables, which comprise the block-level content for this header/footer.

Headers and footers can host the same content as the main document, i.e., paragraphs and tables.

ContentBlocks collection (Document class) Encapsulates the header which appears at the top of a section. Encapsulates the footer which appears at the bottom of a section. Encapsulates a paragraph within the document.

Use the AddTextRun method to add a run of text to the paragraph.

Use the AddHyperlink method to add a hyperlink to the paragraph.

Use the AddInlinePicture and AddInlineShape methods to add an image or shape to the paragraph, which appears in line with the textual content.

Use the AddAnchoredPicture and AddAnchoredShape methods to add an image or shape to the paragraph, which are anchored to a specific location within the document.

Creates a new instance of the class. The Document with which this instance is associated. Returns a collection which contains the anchored content for the associated Paragraph.

Textual content, and content that appears "inline" with text, is added to the paragraph via the ContentRuns collection. Anchored content, such as pictures and shapes, can be added to the paragraph by adding members to the Anchors collection. The members of this collection are stationary; they do not flow along with the textual content, but rather remain at a fixed location within the document.

AnchoredPicture class AnchoredShape class ContentRuns collection Returns a collection which contains the inline content for the associated Paragraph such as text, hyperlinks, inline pictures, and inline shapes.

All textual content for the paragraph is added via the ContentRuns collection. The collection also contains content which appears "inline" with the text; such content is not anchored to a specific location within the document, but rather flows along with adjacent text. Examples of such content are:

  • hyperlinks
  • inline pictures
  • inline shapes

 TextRun class TextHyperlink class InlinePicture class InlineShape class Anchors collection Returns a ParagraphProperties instance which defines the properties of this Paragraph.

The object returned from this property provides a way to change things like alignment, indentation, and line spacing for the paragraph.

Class used to provide the ability to customize resource strings. Creates a new instance of the DocumentsResourceCustomizer class. Gets the customized string identified by the specified string resource name. Name of the string resource that was customized. The customized string or null if the resource wasn't customized. Clears all strings customized by calls to method. Resets a customized string identified by the specified string resource name so that it will load from the resource file. Name of the string resource to customize. Sets a customized string identified by the specified string resource name. Name of the string resource to customize. The customized string. If null this has the same effect as calling Exposes a instance for this assembly. Returns the resource string using the specified name and default culture. Name of the string resource to return. Arguments supplied to the string.Format method when formatting the string. Returns the resource string using the specified resource name and default culture. The string is then formatted using the arguments specified. Name of the string resource to return. Returns the resource object using the specified name. Name of the resource item An object containing the specified resource Returns the for this assembly. Base class from which the Section and DocumentFinalSection classes derive.

The pagination for all content associated with a document section can be customized using the SectionProperties object returned by the Properties property. Use this object to define the page size, margins, and orientation for the section.

Headers and/or footers can be specified for a section using the HeaderAllPages, HeaderFirstPageOnly, FooterAllPages, and FooterFirstPageOnly properties.

Returns a SectionHeader instance which encapsulates the content which appears in the header for the first page in the associated Section. Returns a SectionHeader instance which encapsulates the content which appears in the header for all pages in the associated Section. Returns a SectionFooter instance which encapsulates the content which appears in the footer for the first page in the associated Section. Returns a SectionFooter instance which encapsulates the content which appears in the footer for all pages in the associated Section. Returns a SectionProperties instance which defines the properties of this Section. Encapsulates the pagination properties and header/footer content for a document section. Returns the Paragraph or Table associated with this instance. Returns the Document associated with this instance. Encapsulates the properties of the final document section. Contains the Section instances which define pagination for specific portions of the associated Document. Adds a Section which defines pagination for the specified Table and all content blocks which precede it. A reference to the Section that was added. Adds a Section which defines pagination for the specified Paragraph and all content blocks which precede it. A reference to the Section that was added. Returns a boolean value indicating whether an element associated with the specified Paragraph instance exists in this collection. Returns a boolean value indicating whether an element associated with the specified Paragraph instance exists in this collection. Returns a boolean value indicating whether an element associated with the specified ContentBlock instance exists in this collection. Removes the element associated with the specified paragraph. Removes the element associated with the specified table. Removes all elements from this collection. Returns the string representation of this object. Returns the number of items in this collection. Returns the Section in this collection which is associated with the specified Paragraph The paragraph associated with the section to be returned. Returns the Section in this collection which is associated with the specified Table The table associated with the section to be returned. Encapsulates a table within the document.

A table is a block of content which contains rows and cells. Rows are added to the table using the Rows collection.

The number of columns within the table is determined by the number of elements in the Columns collection.

Creates a new instance of the class. The Document with which this instance is associated. Returns a collection of TableColumn instances which comprise the columns which appear within this table. Returns a collection of TableRow instances which comprise the rows which appear within this table. Returns a TableProperties instance which defines the properties of this Table. Encapsulates a cell within a row.

Base class for the TableRow, TableColumn, and TableCell classes. Returns the Document with which this item is associated. Returns the ordinal position of this item within the collection to which it belongs, or -1 if it does not belong to a collection. Creates a new instance of the class. The Document with which this instance is associated. Assigns a simple text value to the cell. The string to assign.

The SetText method provides a way to assign a simple text value to a table cell, without triggering creation of the ContentBlocks collection or a Paragraph.

To add more complex content such as text with mixed formatting attributes, hyperlinks, images, shapes, and tables, use the ContentBlocks collection.

Note that calling this method causes the contents of the ContentBlocks collection to be emptied.

Returns the TableCellsCollection to which this instance belongs, or null if this cell does not currently belong to a collection. Returns a collection of ContentBlock-derived objects, such as paragraphs or tables, which comprise the block-level content for this table cell.

Table cells can host the same content as the main document, i.e., paragraphs and tables.

Simple text can be assigned to a table cell using the SetText method. This method is extended as a convenience to the developer, so that the cell can display a textual value with no specific font attributes without incurring the overhead associated with triggering creation of this collection, as well as a Paragraph and a TextRun.

Returns a TableCellProperties instance which defines the properties of this TableCell. Returns the TableRow with which this cell is associated, or null if this cell is currently not associated with a row. Returns the Table with which this cell is associated, or null if this cell is currently not associated with a table. Contains the cells which belong to a row.

Base class for collections of types which derive from the TableContent class. Adds a new TableCell to the associated table. A reference to the TableCell that was added. Inserts a new TableCell into the associated table at the specified ordinal position. The ordinal position within this collection at which to insert the row. A reference to the TableCell that was inserted. Returns the TableCell instance at the specified ordinal position within this collection. Returns the TableRow to which this collection belongs. Returns the Table with which this collection is associated. Encapsulates a column within a table.

Creates a new instance of the class. The Document with which this instance is associated. Returns the TableColumnsCollection to which this instance belongs, or null if this column is currently not associated with a table. Returns the Table with which this column is associated, or null if this column is currently not associated with a table. Returns or sets the preferred width for this column.

This property is only applicable when the Layout property is set to 'Fixed'.

PreferredWidth Layout Contains the columns which belong to a table.

Adds a new TableColumn to the associated table. A reference to the TableColumn that was added. Inserts a new TableColumn into the associated table at the specified ordinal position. The ordinal position within this collection at which to insert the row. A reference to the TableColumn that was inserted. Returns the TableColumn instance at the specified ordinal position within this collection. Encapsulates a row within a table.

Creates a new instance of the class. The Document with which this instance is associated. Returns a collection of TableCell instances which comprise the cells in this row.

Because one TableRow can contain a different number of cells than another TableRow in the same Table, the Cells collection is not connected with the Columns collection of the associated table, and must be explicitly populated.

If the Columns collection of the associated Table contains fewer elements than this Cells collection, the additional cells are displayed after the cell which corresponds to the last column.

Returns the TableRowsCollection to which this instance belongs. Returns a TableRowProperties instance which defines the properties of this TableRow. Returns the Table to which this row belongs, or null if this row is currently not associated with any table. Contains the rows which belong to a table.

Adds a new TableRow to the associated table. A reference to the TableRow that was added. Inserts a new TableRow into the associated table at the specified ordinal position. The ordinal position within this collection at which to insert the row. A reference to the TableRow that was inserted. Returns the TableRow instance at the specified ordinal position within this collection. Contains version information for the Infragistics assemblies. Major.Minor number portion of the assembly version Build number portion of the assembly version Revision number portion of the assembly version Assembly version number Assembly company name End year of assembly copyright The assembly version number for the satellite assemblies. The current build configuration for the assembly.