API Reference
RtfTableRow
RTF table row.
Inheritance
- Object
- RtfTableRow
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property RtfStyle.TableRowFormat
- Method RtfTable.AddRow
- Property RtfTable.Rows
- Method RtfTableRow.SetAlignment
- Method RtfTableRow.SetAutoFit
- Method RtfTableRow.SetBackgroundColor
- Method RtfTableRow.SetCellGap
- Method RtfTableRow.SetDirection
- Method RtfTableRow.SetLeftIndent
- Method RtfTableRow.SetPadding
- Method RtfTableRow.SetPosition
- Method RtfTableRow.SetPositionAnchors
- Method RtfTableRow.SetShading
- Method RtfTableRow.SetSpacing
- Method RtfTableRow.SetTextWrapDistances
Constructors
public RtfTableRow() #Methods
public RtfTableCell AddCell(Nullable<Int32> rightBoundaryTwips = null) #RtfTableCellAdds a cell.
Parameters
- rightBoundaryTwips System.Nullable{System.Int32} = null
public RtfTableRowBorder GetBorder(RtfTableRowBorderSide side) #RtfTableRowBorderGets one of the row borders.
Parameters
- side OfficeIMO.Rtf.RtfTableRowBorderSide
public RtfTableRow SetAlignment(Nullable<RtfTableAlignment> alignment) #RtfTableRowSets the row alignment.
Parameters
- alignment System.Nullable{OfficeIMO.Rtf.RtfTableAlignment}
public RtfTableRow SetAutoFit(Nullable<Boolean> autoFit) #RtfTableRowSets the row AutoFit toggle.
Parameters
- autoFit System.Nullable{System.Boolean}
public RtfTableRow SetBackgroundColor(Nullable<Int32> colorIndex) #RtfTableRowSets row background shading to a one-based color table index.
Parameters
- colorIndex System.Nullable{System.Int32}
public RtfTableRow SetCellGap(Nullable<Int32> cellGapTwips) #RtfTableRowSets the row cell gap in twips.
Parameters
- cellGapTwips System.Nullable{System.Int32}
public RtfTableRow SetDirection(Nullable<RtfTableRowDirection> direction) #RtfTableRowSets the row reading order.
Parameters
- direction System.Nullable{OfficeIMO.Rtf.RtfTableRowDirection}
public RtfTableRow SetLeftIndent(Nullable<Int32> leftIndentTwips) #RtfTableRowSets the row left indent in twips.
Parameters
- leftIndentTwips System.Nullable{System.Int32}
public RtfTableRow SetPadding(Nullable<Int32> topTwips = null, Nullable<Int32> leftTwips = null, Nullable<Int32> bottomTwips = null, Nullable<Int32> rightTwips = null) #RtfTableRowSets default row cell padding in twips.
Parameters
- topTwips System.Nullable{System.Int32} = null
- leftTwips System.Nullable{System.Int32} = null
- bottomTwips System.Nullable{System.Int32} = null
- rightTwips System.Nullable{System.Int32} = null
public RtfTableRow SetPosition(Nullable<RtfTableHorizontalPosition> horizontalPosition = null, Nullable<Int32> horizontalTwips = null, Nullable<RtfTableVerticalPosition> verticalPosition = null, Nullable<Int32> verticalTwips = null) #RtfTableRowSets the positioned table row placement modes.
Parameters
- horizontalPosition System.Nullable{OfficeIMO.Rtf.RtfTableHorizontalPosition} = null
- horizontalTwips System.Nullable{System.Int32} = null
- verticalPosition System.Nullable{OfficeIMO.Rtf.RtfTableVerticalPosition} = null
- verticalTwips System.Nullable{System.Int32} = null
public RtfTableRow SetPositionAnchors(Nullable<RtfTableHorizontalAnchor> horizontalAnchor, Nullable<RtfTableVerticalAnchor> verticalAnchor) #RtfTableRowSets the positioned table row anchors.
Parameters
- horizontalAnchor System.Nullable{OfficeIMO.Rtf.RtfTableHorizontalAnchor}
- verticalAnchor System.Nullable{OfficeIMO.Rtf.RtfTableVerticalAnchor}
public RtfTableRow SetShading(Nullable<Int32> backgroundColorIndex, Nullable<Int32> foregroundColorIndex = null, Nullable<Int32> patternValue = null, Nullable<Int32> patternPercent = null, RtfShadingPattern pattern = None) #RtfTableRowSets row shading color and pattern metadata.
Parameters
- backgroundColorIndex System.Nullable{System.Int32}
- foregroundColorIndex System.Nullable{System.Int32} = null
- patternValue System.Nullable{System.Int32} = null
- patternPercent System.Nullable{System.Int32} = null
- pattern OfficeIMO.Rtf.RtfShadingPattern = None
public RtfTableRow SetSpacing(Nullable<Int32> topTwips = null, Nullable<Int32> leftTwips = null, Nullable<Int32> bottomTwips = null, Nullable<Int32> rightTwips = null) #RtfTableRowSets default row cell spacing in twips.
Parameters
- topTwips System.Nullable{System.Int32} = null
- leftTwips System.Nullable{System.Int32} = null
- bottomTwips System.Nullable{System.Int32} = null
- rightTwips System.Nullable{System.Int32} = null
public RtfTableRow SetTextWrapDistances(Nullable<Int32> leftTwips = null, Nullable<Int32> rightTwips = null, Nullable<Int32> topTwips = null, Nullable<Int32> bottomTwips = null) #RtfTableRowSets positioned table row text wrapping distances in twips.
Parameters
- leftTwips System.Nullable{System.Int32} = null
- rightTwips System.Nullable{System.Int32} = null
- topTwips System.Nullable{System.Int32} = null
- bottomTwips System.Nullable{System.Int32} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IReadOnlyList<RtfTableCell> Cells { get; } #Cells in the row.
public Boolean RepeatHeader { get; set; } #Whether this row repeats as a table header.
public Boolean KeepTogether { get; set; } #Whether this row should be kept together on one page, represented by \trkeep.
public Boolean KeepWithNext { get; set; } #Whether this row should be kept with the following row, represented by \trkeepfollow.
public Nullable<Boolean> AutoFit { get; set; } #Optional AutoFit toggle for this row, represented by \trautofit.
public Nullable<RtfTableRowDirection> Direction { get; set; } #Optional table row reading order, represented by \ltrrow or \rtlrow.
public Nullable<Int32> HeightTwips { get; set; } #Preferred row height in twips.
public Nullable<Int32> CellGapTwips { get; set; } #Half of the inter-cell gap in twips represented by \trgaph.
public Nullable<Int32> LeftIndentTwips { get; set; } #Left row indent in twips represented by \trleft.
public Nullable<RtfTableAlignment> Alignment { get; set; } #Optional row alignment represented by \trql, \trqc, or \trqr.
public Nullable<Int32> PreferredWidth { get; set; } #Preferred table width value carried by \trwWidth for this row definition.
public Nullable<RtfTableWidthUnit> PreferredWidthUnit { get; set; } #Preferred table width unit carried by \trftsWidth for this row definition.
public Nullable<Int32> BackgroundColorIndex { get; set; } #One-based color table index used for table row background shading.
public Nullable<Int32> ShadingForegroundColorIndex { get; set; } #One-based color table index used for table row pattern foreground shading.
public Nullable<Int32> ShadingPatternValue { get; set; } #Raw RTF \trpat table row shading pattern value.
public Nullable<Int32> ShadingPatternPercent { get; set; } #Raw RTF \trshdng value, where 10000 represents 100 percent.
public RtfShadingPattern ShadingPattern { get; set; } #Named RTF table row shading pattern.
public Nullable<Int32> PaddingTopTwips { get; set; } #Default top cell padding for this row in twips.
public Nullable<Int32> PaddingLeftTwips { get; set; } #Default left cell padding for this row in twips.
public Nullable<Int32> PaddingBottomTwips { get; set; } #Default bottom cell padding for this row in twips.
public Nullable<Int32> PaddingRightTwips { get; set; } #Default right cell padding for this row in twips.
public Nullable<Int32> SpacingTopTwips { get; set; } #Default top cell spacing for this row in twips.
public Nullable<Int32> SpacingLeftTwips { get; set; } #Default left cell spacing for this row in twips.
public Nullable<Int32> SpacingBottomTwips { get; set; } #Default bottom cell spacing for this row in twips.
public Nullable<Int32> SpacingRightTwips { get; set; } #Default right cell spacing for this row in twips.
public Boolean NoOverlap { get; set; } #Whether this positioned row should avoid overlapping similar floating tables, represented by \tabsnoovrlp.
public Nullable<RtfTableHorizontalAnchor> HorizontalAnchor { get; set; } #Horizontal positioning reference frame for this row.
public Nullable<RtfTableVerticalAnchor> VerticalAnchor { get; set; } #Vertical positioning reference frame for this row.
public Nullable<RtfTableHorizontalPosition> HorizontalPosition { get; set; } #Horizontal table placement mode for this row.
public Nullable<Int32> HorizontalPositionTwips { get; set; } #Horizontal position value in twips for absolute placement modes.
public Nullable<RtfTableVerticalPosition> VerticalPosition { get; set; } #Vertical table placement mode for this row.
public Nullable<Int32> VerticalPositionTwips { get; set; } #Vertical position value in twips for absolute placement modes.
public Nullable<Int32> TextWrapLeftTwips { get; set; } #Distance between surrounding text and the left edge of a positioned table.
public Nullable<Int32> TextWrapRightTwips { get; set; } #Distance between surrounding text and the right edge of a positioned table.
public Nullable<Int32> TextWrapTopTwips { get; set; } #Distance between surrounding text and the top edge of a positioned table.
public Nullable<Int32> TextWrapBottomTwips { get; set; } #Distance between surrounding text and the bottom edge of a positioned table.
public RtfTableRowBorder TopBorder { get; set; } #Top row border.
public RtfTableRowBorder LeftBorder { get; set; } #Left row border.
public RtfTableRowBorder BottomBorder { get; set; } #Bottom row border.
public RtfTableRowBorder RightBorder { get; set; } #Right row border.
public RtfTableRowBorder HorizontalBorder { get; set; } #Horizontal inside row border.
public RtfTableRowBorder VerticalBorder { get; set; } #Vertical inside row border.