GrapeCity.Documents.Word.RowFormat

Class RowFormat

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents formatting for a table row.

public class RowFormat : FormattingBag

Inheritance

object

FormattingBag

RowFormat

Inherited Members

FormattingBag.KeyDelimiter

FormattingBag.KeyFormat

FormattingBag.FixInheritedValues()

FormattingBag.GetFormattingKey(string)

FormattingBag.GetShortKey(string)

FormattingBag.GetChildKeyPart(string)

FormattingBag.ConcateKeys(string, string)

FormattingBag.ConcateKeys(string[], string)

FormattingBag.ConcateKeys(string, string[])

FormattingBag.GetFormatting<T>(string, T)

FormattingBag.GetFormatting<T>(string, T, out int, bool)

FormattingBag.GetPropertyFormatting<T>(T, string)

FormattingBag.SetFormatting(string, object, bool)

FormattingBag.UpdateVersion(int?)

FormattingBag.SetPropertyFormatting(object, string)

FormattingBag.SetFormatting<T>(string, object, T, bool)

FormattingBag.SetPropertyFormattingEx<T>(object, T, string)

FormattingBag.GetDirectFormatting<T>(string, T)

FormattingBag.TryGetDirectFormatting<T>(string, T, out T, bool)

FormattingBag.GetDirectPropertyFormatting<T>(T, string)

FormattingBag.SetDirectPropertyFormatting(object, string)

FormattingBag.SetDirectPropertyFormattingEx<T>(object, T, string)

FormattingBag.RemoveDirectFormatting(string)

FormattingBag.HasDirectFormatting(string)

FormattingBag.HasDirectPropertyFormatting(string)

FormattingBag.HasDirectFormatting(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string, string)

FormattingBag.BaseKey

FormattingBag.ParentKey

FormattingBag.RootKey

FormattingBag.SyncBaseKeys

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Alignment

Gets or sets a value specifying how the table row is aligned in the document.

public TableAlignment Alignment { get; set; }

Property Value

TableAlignment

AllowBreakAcrossPages

Gets or sets a value indicating whether the contents within the current cell can be split between pages.

public bool AllowBreakAcrossPages { get; set; }

Property Value

bool

Remarks

When displaying the contents of a table cell, it is possible that a page break would fall within the contents of a table cell, causing the contents of that cell to be displayed across two different pages. If this property is false, then all contents of a table row shall be rendered on the same page by moving the start of the current row to the start of a new page if necessary. If the contents of this table row cannot fit on a single page, then this row shall start on a new page and flow onto multiple pages as necessary.

HeadingFormat

Gets or sets whether the current table row shall be repeated at the top of each new page on which part of this table is displayed. This gives this table row the behavior of a 'header' row on each of these pages. This property can be applied to any number of rows at the top of the table structure in order to generate multi-row table headers.

public bool HeadingFormat { get; set; }

Property Value

bool

Remarks

If false, this table row shall not be repeated on each new page on which the table is displayed. As well, if this row is not contiguously connected with the first row of the table (that is, if this table row is not either the first row, or all rows between this row and the first row are not marked as header rows) then this property shall be ignored.

Height

Gets or sets the height of the table row in points.

public float Height { get; set; }

Property Value

float

Remarks

The meaning of the value is defined based on the value of the HeightRule value for this table row as follows: If the value of HeightRule is Auto, then the table row height should be automatically determined based on the height of its contents. This value is ignored. If the value of HeightRule is AtLeast, then the table row's height should be at least the value of this property. If the value of HeightRule is Exact, then the table row's height should be exactly the value of this property.

HeightRule

Gets or sets the rule for determining the height of the table row.

public HeightRule HeightRule { get; set; }

Property Value

HeightRule

Spacing

Gets or sets the default amount of space (in points) between the cells.

public float Spacing { get; set; }

Property Value

float

Methods

ClearFormatting()

Resets to default row formatting.

public override void ClearFormatting()