Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

RtfTableCell

Namespace OfficeIMO.Rtf
Assembly OfficeIMO.Rtf
Implements
IRtfCloneable
Modifiers sealed

RTF table cell.

Inheritance

  • Object
  • RtfTableCell

Usage

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

Constructors

Methods

public RtfParagraph AddParagraph(String text = null) #
Returns: RtfParagraph

Adds a paragraph to the cell.

Parameters

text System.String = null optionalposition: 0
public RtfTable AddTable(Int32 rows, Int32 columns) #
Returns: RtfTable

Adds a nested table to the cell.

Parameters

rows System.Int32 requiredposition: 0
columns System.Int32 requiredposition: 1
public RtfTableCell SetBackgroundColor(Nullable<Int32> colorIndex) #
Returns: RtfTableCell

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

Parameters

colorIndex System.Nullable{System.Int32} requiredposition: 0
public RtfTableCell SetFitText(Boolean fitText = true) #
Returns: RtfTableCell

Sets whether text is compressed to fit within the cell width.

Parameters

fitText System.Boolean = true optionalposition: 0
public RtfTableCell SetHideCellMark(Boolean hidden = true) #
Returns: RtfTableCell

Sets whether the end-of-cell mark is hidden.

Parameters

hidden System.Boolean = true optionalposition: 0
public RtfTableCell SetNoWrap(Boolean noWrap = true) #
Returns: RtfTableCell

Sets whether text should not wrap inside the cell.

Parameters

noWrap System.Boolean = true optionalposition: 0
public RtfTableCell SetPadding(Nullable<Int32> topTwips = null, Nullable<Int32> leftTwips = null, Nullable<Int32> bottomTwips = null, Nullable<Int32> rightTwips = null) #
Returns: RtfTableCell

Sets cell padding in twips.

Parameters

topTwips System.Nullable{System.Int32} = null optionalposition: 0
leftTwips System.Nullable{System.Int32} = null optionalposition: 1
bottomTwips System.Nullable{System.Int32} = null optionalposition: 2
rightTwips System.Nullable{System.Int32} = null optionalposition: 3
public RtfTableCell SetPreferredWidth(Nullable<Int32> width, Nullable<RtfTableWidthUnit> unit = null) #
Returns: RtfTableCell

Sets the preferred cell width.

Parameters

width System.Nullable{System.Int32} requiredposition: 0
unit System.Nullable{OfficeIMO.Rtf.RtfTableWidthUnit} = null optionalposition: 1
public RtfTableCell SetShading(Nullable<Int32> backgroundColorIndex, Nullable<Int32> foregroundColorIndex = null, Nullable<Int32> patternPercent = null, RtfShadingPattern pattern = None) #
Returns: RtfTableCell

Sets cell shading color and pattern metadata.

Parameters

backgroundColorIndex System.Nullable{System.Int32} requiredposition: 0
foregroundColorIndex System.Nullable{System.Int32} = null optionalposition: 1
patternPercent System.Nullable{System.Int32} = null optionalposition: 2
pattern OfficeIMO.Rtf.RtfShadingPattern = None optionalposition: 3
public RtfTableCell SetTextFlow(Nullable<RtfTableCellTextFlow> textFlow) #
Returns: RtfTableCell

Sets the cell text flow.

Parameters

textFlow System.Nullable{OfficeIMO.Rtf.RtfTableCellTextFlow} requiredposition: 0

Properties

public IReadOnlyList<RtfParagraph> Paragraphs { get; } #

Paragraphs in the cell.

public IReadOnlyList<IRtfBlock> Blocks { get; } #

Ordered cell blocks, including paragraphs and nested tables.

public Nullable<Int32> RightBoundaryTwips { get; set; } #

Right cell boundary in twips.

public RtfTableCellMerge HorizontalMerge { get; set; } #

Horizontal merge marker.

public RtfTableCellMerge VerticalMerge { get; set; } #

Vertical merge marker.

public Nullable<Int32> BackgroundColorIndex { get; set; } #

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

public Nullable<Int32> ShadingForegroundColorIndex { get; set; } #

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

public Nullable<Int32> ShadingPatternPercent { get; set; } #

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

public RtfShadingPattern ShadingPattern { get; set; } #

Named RTF cell shading pattern.

public Nullable<RtfTableCellVerticalAlignment> VerticalAlignment { get; set; } #

Vertical alignment for cell content.

public Nullable<RtfTableCellTextFlow> TextFlow { get; set; } #

Text flow for cell content.

public Nullable<Int32> PreferredWidth { get; set; } #

Preferred cell width value carried by \clwWidth.

public Nullable<RtfTableWidthUnit> PreferredWidthUnit { get; set; } #

Preferred cell width unit carried by \clftsWidth.

public Boolean HideCellMark { get; set; } #

Whether the end-of-cell mark is hidden, represented by \clhidemark.

public Boolean NoWrap { get; set; } #

Whether text should not wrap inside the cell, represented by \clNoWrap.

public Boolean FitText { get; set; } #

Whether text is compressed to fit within the cell width, represented by \clFitText.

public Nullable<Int32> PaddingTopTwips { get; set; } #

Top cell padding in twips.

public Nullable<Int32> PaddingLeftTwips { get; set; } #

Left cell padding in twips.

public Nullable<Int32> PaddingBottomTwips { get; set; } #

Bottom cell padding in twips.

public Nullable<Int32> PaddingRightTwips { get; set; } #

Right cell padding in twips.

public RtfTableCellBorder TopBorder { get; set; } #

Top cell border.

public RtfTableCellBorder LeftBorder { get; set; } #

Left cell border.

public RtfTableCellBorder BottomBorder { get; set; } #

Bottom cell border.

public RtfTableCellBorder RightBorder { get; set; } #

Right cell border.

public RtfTableCellBorder TopLeftToBottomRightBorder { get; set; } #

Diagonal cell border from top-left to bottom-right.

public RtfTableCellBorder TopRightToBottomLeftBorder { get; set; } #

Diagonal cell border from top-right to bottom-left.