Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfTableRow

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
Implements
IRtfCloneable
Modifiers
sealed

RTF table row.

Inheritance

  • object
  • RtfTableRow

Usage

Explore 15 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Constructors

public RtfTableRow() #

Methods

public RtfTableCell AddCell(int? rightBoundaryTwips = null) #

Adds a cell.

Parameters

rightBoundaryTwips int? = null optional
public RtfTableRowBorder GetBorder(RtfTableRowBorderSide side) #

Gets one of the row borders.

Parameters

side OfficeIMO.Rtf.RtfTableRowBorderSide required
public RtfTableRow SetAlignment(RtfTableAlignment? alignment) #

Sets the row alignment.

Parameters

alignment OfficeIMO.Rtf.RtfTableAlignment? required
public RtfTableRow SetAutoFit(bool? autoFit) #

Sets the row AutoFit toggle.

Parameters

autoFit bool? required
public RtfTableRow SetBackgroundColor(int? colorIndex) #

Sets row background shading to a one-based color table index.

Parameters

colorIndex int? required
public RtfTableRow SetCellGap(int? cellGapTwips) #

Sets the row cell gap in twips.

Parameters

cellGapTwips int? required
public RtfTableRow SetDirection(RtfTableRowDirection? direction) #

Sets the row reading order.

Parameters

direction OfficeIMO.Rtf.RtfTableRowDirection? required
public RtfTableRow SetLeftIndent(int? leftIndentTwips) #

Sets the row left indent in twips.

Parameters

leftIndentTwips int? required
public RtfTableRow SetPadding(int? topTwips = null, int? leftTwips = null, int? bottomTwips = null, int? rightTwips = null) #

Sets default row cell padding in twips.

Parameters

topTwips int? = null optional
leftTwips int? = null optional
bottomTwips int? = null optional
rightTwips int? = null optional
public RtfTableRow SetPosition(RtfTableHorizontalPosition? horizontalPosition = null, int? horizontalTwips = null, RtfTableVerticalPosition? verticalPosition = null, int? verticalTwips = null) #

Sets the positioned table row placement modes.

Parameters

horizontalPosition OfficeIMO.Rtf.RtfTableHorizontalPosition? = null optional
horizontalTwips int? = null optional
verticalPosition OfficeIMO.Rtf.RtfTableVerticalPosition? = null optional
verticalTwips int? = null optional
public RtfTableRow SetPositionAnchors(RtfTableHorizontalAnchor? horizontalAnchor, RtfTableVerticalAnchor? verticalAnchor) #

Sets the positioned table row anchors.

Parameters

horizontalAnchor OfficeIMO.Rtf.RtfTableHorizontalAnchor? required
verticalAnchor OfficeIMO.Rtf.RtfTableVerticalAnchor? required
public RtfTableRow SetShading(int? backgroundColorIndex, int? foregroundColorIndex = null, int? patternValue = null, int? patternPercent = null, RtfShadingPattern pattern = None) #

Sets row shading color and pattern metadata.

Parameters

backgroundColorIndex int? required
foregroundColorIndex int? = null optional
patternValue int? = null optional
patternPercent int? = null optional
pattern OfficeIMO.Rtf.RtfShadingPattern = None optional
public RtfTableRow SetSpacing(int? topTwips = null, int? leftTwips = null, int? bottomTwips = null, int? rightTwips = null) #

Sets default row cell spacing in twips.

Parameters

topTwips int? = null optional
leftTwips int? = null optional
bottomTwips int? = null optional
rightTwips int? = null optional
public RtfTableRow SetTextWrapDistances(int? leftTwips = null, int? rightTwips = null, int? topTwips = null, int? bottomTwips = null) #

Sets positioned table row text wrapping distances in twips.

Parameters

leftTwips int? = null optional
rightTwips int? = null optional
topTwips int? = null optional
bottomTwips int? = null optional

Properties

public IReadOnlyList<RtfTableCell> Cells { get; } #

Cells in the row.

public bool RepeatHeader { get; set; } #

Whether this row repeats as a table header.

public bool KeepTogether { get; set; } #

Whether this row should be kept together on one page, represented by \trkeep.

public bool KeepWithNext { get; set; } #

Whether this row should be kept with the following row, represented by \trkeepfollow.

public bool? AutoFit { get; set; } #

Optional AutoFit toggle for this row, represented by \trautofit.

public RtfTableRowDirection? Direction { get; set; } #

Optional table row reading order, represented by \ltrrow or \rtlrow.

public int? HeightTwips { get; set; } #

Preferred row height in twips.

public int? CellGapTwips { get; set; } #

Half of the inter-cell gap in twips represented by \trgaph.

public int? LeftIndentTwips { get; set; } #

Left row indent in twips represented by \trleft.

public RtfTableAlignment? Alignment { get; set; } #

Optional row alignment represented by \trql, \trqc, or \trqr.

public int? PreferredWidth { get; set; } #

Preferred table width value carried by \trwWidth for this row definition.

public RtfTableWidthUnit? PreferredWidthUnit { get; set; } #

Preferred table width unit carried by \trftsWidth for this row definition.

public int? BackgroundColorIndex { get; set; } #

One-based color table index used for table row background shading.

public int? ShadingForegroundColorIndex { get; set; } #

One-based color table index used for table row pattern foreground shading.

public int? ShadingPatternValue { get; set; } #

Raw RTF \trpat table row shading pattern value.

public int? ShadingPatternPercent { get; set; } #

Raw RTF \trshdng value, where 10000 represents 100 percent.

public RtfShadingPattern ShadingPattern { get; set; } #

Named RTF table row shading pattern.

public int? PaddingTopTwips { get; set; } #

Default top cell padding for this row in twips.

public int? PaddingLeftTwips { get; set; } #

Default left cell padding for this row in twips.

public int? PaddingBottomTwips { get; set; } #

Default bottom cell padding for this row in twips.

public int? PaddingRightTwips { get; set; } #

Default right cell padding for this row in twips.

public int? SpacingTopTwips { get; set; } #

Default top cell spacing for this row in twips.

public int? SpacingLeftTwips { get; set; } #

Default left cell spacing for this row in twips.

public int? SpacingBottomTwips { get; set; } #

Default bottom cell spacing for this row in twips.

public int? SpacingRightTwips { get; set; } #

Default right cell spacing for this row in twips.

public bool NoOverlap { get; set; } #

Whether this positioned row should avoid overlapping similar floating tables, represented by \tabsnoovrlp.

public RtfTableHorizontalAnchor? HorizontalAnchor { get; set; } #

Horizontal positioning reference frame for this row.

public RtfTableVerticalAnchor? VerticalAnchor { get; set; } #

Vertical positioning reference frame for this row.

public RtfTableHorizontalPosition? HorizontalPosition { get; set; } #

Horizontal table placement mode for this row.

public int? HorizontalPositionTwips { get; set; } #

Horizontal position value in twips for absolute placement modes.

public RtfTableVerticalPosition? VerticalPosition { get; set; } #

Vertical table placement mode for this row.

public int? VerticalPositionTwips { get; set; } #

Vertical position value in twips for absolute placement modes.

public int? TextWrapLeftTwips { get; set; } #

Distance between surrounding text and the left edge of a positioned table.

public int? TextWrapRightTwips { get; set; } #

Distance between surrounding text and the right edge of a positioned table.

public int? TextWrapTopTwips { get; set; } #

Distance between surrounding text and the top edge of a positioned table.

public int? TextWrapBottomTwips { get; set; } #

Distance between surrounding text and the bottom edge of a positioned table.

public RtfTableRowBorder TopBorder { get; private set; } #

Top row border.

public RtfTableRowBorder LeftBorder { get; private set; } #

Left row border.

public RtfTableRowBorder BottomBorder { get; private set; } #

Bottom row border.

public RtfTableRowBorder RightBorder { get; private set; } #

Right row border.

public RtfTableRowBorder HorizontalBorder { get; private set; } #

Horizontal inside row border.

public RtfTableRowBorder VerticalBorder { get; private set; } #

Vertical inside row border.