TableRowFormat Class

Namespace:
GemBox.Document.Tables
Assembly:
GemBox.Document.dll

Represents a set of row-level properties applied to the TableRow element.

public sealed class TableRowFormat : Format
Public NotInheritable Class TableRowFormat
    Inherits Format
Inheritance:
System.Object
TableRowFormat

Constructors

TableRowFormat()

Initializes a new instance of the TableRowFormat class.

public TableRowFormat()
Public Sub New

Properties

AllowBreakAcrossPages

Gets or sets a value indicating whether all contents of a table row shall be rendered on the same page.

public bool AllowBreakAcrossPages { get; set; }
Public Property AllowBreakAcrossPages As Boolean
Property Value
System.Boolean

true if splitting the table row across multiple pages is allowed; otherwise, false.

Height

Gets or sets the table row height.

public TableRowHeight Height { get; set; }
Public Property Height As TableRowHeight
Property Value
TableRowHeight

The table row height.

Hidden

Gets or sets a value indicating whether TableRow shall be hidden from display at display time in a document.

public bool Hidden { get; set; }
Public Property Hidden As Boolean
Property Value
System.Boolean

true if TableRow shall be hidden from display at display time in a document; otherwise, false.

RepeatOnEachPage

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.

public bool RepeatOnEachPage { get; set; }
Public Property RepeatOnEachPage As Boolean
Property Value
System.Boolean

true if table row shall be repeated at the top of each new page on which part of its table is displayed; otherwise, false.

Methods

ClearFormatting()

Clears the formatting.

public override void ClearFormatting()
Public Overrides Sub ClearFormatting
Overrides
Remarks

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.

Clone()

Clones this TableRowFormat instance.

public TableRowFormat Clone()
Public Function Clone As TableRowFormat
Returns
TableRowFormat

Clone(Boolean)

Clones this TableRowFormat 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 TableRowFormat).

public TableRowFormat Clone(bool resolveValues)
Public Function Clone(resolveValues As Boolean) As TableRowFormat
Parameters
resolveValues
System.Boolean

If true, 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.

Returns
TableRowFormat

Equals(Object)

Determines whether the specified System.Object is equal to this TableRowFormat instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this table row format instance.

Returns
System.Boolean

true if the specified System.Object is a TableRowFormat and is equal to this TableRowFormat instance; otherwise, false.

Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for this TableRowFormat instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this TableRowFormat instance.

Overrides
System.Object.GetHashCode()

Operators

Equality(TableRowFormat, TableRowFormat)

Determines whether first and second TableRowFormats are equal.

public static bool operator ==(TableRowFormat first, TableRowFormat second)
Public Shared Operator =(first As TableRowFormat, second As TableRowFormat) As Boolean
Parameters
first
TableRowFormat

The first table row format.

second
TableRowFormat

The second table row format.

Returns
System.Boolean

true if first and second table row formats are equal; otherwise, false.

Inequality(TableRowFormat, TableRowFormat)

Determines whether first and second TableRowFormats are not equal.

public static bool operator !=(TableRowFormat first, TableRowFormat second)
Public Shared Operator <>(first As TableRowFormat, second As TableRowFormat) As Boolean
Parameters
first
TableRowFormat

The first table row format.

second
TableRowFormat

The second table row format.

Returns
System.Boolean

true if first and second table row formats are not equal; otherwise, false.

Inherited Properties

Document

Gets the owner document.

(Inherited from Format)

Examples