GrapeCity.Documents.Word.TextFrame

Class TextFrame

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents the text content of a Shape and associates that textual information, referred to as a text frame story, with a story identifier.

public class TextFrame : ContentObject, IBrowsable<TextFrame>

Inheritance

object

ContentObject

TextFrame

Implements

IBrowsable<TextFrame>

Inherited Members

ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.ToString()

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Format

Gets the text frame format properties.

public TextFrameFormat Format { get; }

Property Value

TextFrameFormat

ID

Gets the identifier of the text frame story.

public ushort ID { get; }

Property Value

ushort

LinkedTextFrames

Gets a read-only list of all linked text frames in this text frame story, in correct order.

public IReadOnlyList<LinkedTextFrame> LinkedTextFrames { get; }

Property Value

System.Collections.Generic.IReadOnlyList<T><LinkedTextFrame>

Next

Gets the next text frame.

public TextFrame Next { get; }

Property Value

TextFrame

ParentShape

Gets the parent shape.

public Shape ParentShape { get; }

Property Value

Shape

Previous

Gets the previous text frame.

public TextFrame Previous { get; }

Property Value

TextFrame

Methods

AddContentControl(ContentControlType, bool)

Adds a ContentControl to the end of the text frame.

public ContentControl AddContentControl(ContentControlType type, bool fillContent = true)

Parameters

type ContentControlType

The new content control type.

fillContent bool

Whether to fill the new control content with default data.

Returns

ContentControl

The added ContentControl.

AddParagraph()

Adds a Paragraph to the end of the text frame.

public Paragraph AddParagraph()

Returns

Paragraph

The added Paragraph.

AddParagraph(Style)

Adds a Paragraph to the end of the text frame.

public Paragraph AddParagraph(Style style)

Parameters

style Style

The paragraph style.

Returns

Paragraph

The added Paragraph.

AddParagraph(string, Style)

Adds a Paragraph to the end of the text frame.

public Paragraph AddParagraph(string text, Style style)

Parameters

text string

The text of the added Paragraph

style Style

The paragraph style.

Returns

Paragraph

The added Paragraph.

AddParagraph(string)

Adds a Paragraph to the end of the text frame.

public Paragraph AddParagraph(string text)

Parameters

text string

The text of the added Paragraph

Returns

Paragraph

The added Paragraph.

AddTable()

Adds a Table to the end of the text frame.

public Table AddTable()

Returns

Table

The added Table.

AddTable(Style)

Adds a Table to the end of the text frame.

public Table AddTable(Style style)

Parameters

style Style

The table style.

Returns

Table

The added Table.

AddTable(int, int, Style)

Adds a Table to the end of the text frame.

public Table AddTable(int columns, int rows, Style style)

Parameters

columns int

The number of columns in the new table.

rows int

The number of rows in the new table.

style Style

The table style.

Returns

Table

The added Table.

AddTable(int, int)

Adds a Table to the end of the text frame.

public Table AddTable(int columns, int rows)

Parameters

columns int

The number of columns in the new table.

rows int

The number of rows in the new table.

Returns

Table

The added Table.

AddTable(string[][], Style)

Adds a Table to the end of the text frame.

public Table AddTable(string[][] texts, Style style)

Parameters

texts string[][]

A two dimensional array of texts to put in the cells. The first dimension determines the number of rows, the second the number of cells.

style Style

The table style.

Returns

Table

The added Table.

AddTable(string[][])

Adds a Table to the end of the text frame.

public Table AddTable(string[][] texts)

Parameters

texts string[][]

A two dimensional array of texts to put in the cells. The first dimension determines the number of rows, the second the number of cells.

Returns

Table

The added Table.