Get Started

API Reference

Class

PdfTableCell

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Model/PdfTableCell.cs:8
Modifiers sealed

Represents a table cell with optional Word-like column and row spanning.

Inheritance

  • Object
  • PdfTableCell

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

Accepted by parameters

Constructors

PdfTableCell 2 overloads
public PdfTableCell(String text, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, IEnumerable<PdfTableCellCheckBox> checkBoxes = null, IEnumerable<PdfTableCellFormField> formFields = null, IEnumerable<PdfTableCellImage> images = null, String linkDestinationName = null, String namedDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:8

Creates a table cell with text content, optional column/row spans, optional link metadata, images, and form fields.

Parameters

text System.String requiredposition: 0
columnSpan System.Int32 = 1 optionalposition: 1
linkUri System.String = null optionalposition: 2
linkContents System.String = null optionalposition: 3
rowSpan System.Int32 = 1 optionalposition: 4
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} = null optionalposition: 5
formFields System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellFormField} = null optionalposition: 6
images System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellImage} = null optionalposition: 7
linkDestinationName System.String = null optionalposition: 8
namedDestinationName System.String = null optionalposition: 9
public PdfTableCell(IEnumerable<TextRun> runs, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, IEnumerable<PdfTableCellCheckBox> checkBoxes = null, IEnumerable<PdfTableCellFormField> formFields = null, IEnumerable<PdfTableCellImage> images = null, String linkDestinationName = null, String namedDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:25

Creates a table cell with rich text runs, optional column/row spans, optional link metadata, images, and form fields.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
columnSpan System.Int32 = 1 optionalposition: 1
linkUri System.String = null optionalposition: 2
linkContents System.String = null optionalposition: 3
rowSpan System.Int32 = 1 optionalposition: 4
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} = null optionalposition: 5
formFields System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellFormField} = null optionalposition: 6
images System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellImage} = null optionalposition: 7
linkDestinationName System.String = null optionalposition: 8
namedDestinationName System.String = null optionalposition: 9

Methods

Merge 2 overloads
public static PdfTableCell Merge(String text, Int32 columnSpan = 1, Int32 rowSpan = 1, String linkUri = null, String linkContents = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:132
Returns: PdfTableCell

Creates a merged cell spanning logical columns and rows.

Parameters

text System.String requiredposition: 0
columnSpan System.Int32 = 1 optionalposition: 1
rowSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
linkDestinationName System.String = null optionalposition: 5
public static PdfTableCell Merge(IEnumerable<TextRun> runs, Int32 columnSpan = 1, Int32 rowSpan = 1, String linkUri = null, String linkContents = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:135
Returns: PdfTableCell

Creates a rich text merged cell spanning logical columns and rows.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
columnSpan System.Int32 = 1 optionalposition: 1
rowSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
linkDestinationName System.String = null optionalposition: 5
public static PdfTableCell RichTextCell(IEnumerable<TextRun> runs, String linkUri = null, String linkContents = null, String linkDestinationName = null, String namedDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:123
Returns: PdfTableCell

Creates a single-column rich text cell.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
linkUri System.String = null optionalposition: 1
linkContents System.String = null optionalposition: 2
linkDestinationName System.String = null optionalposition: 3
namedDestinationName System.String = null optionalposition: 4
Span 2 overloads
public static PdfTableCell Span(String text, Int32 columnSpan, String linkUri = null, String linkContents = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:126
Returns: PdfTableCell

Creates a cell spanning multiple logical columns.

Parameters

text System.String requiredposition: 0
columnSpan System.Int32 requiredposition: 1
linkUri System.String = null optionalposition: 2
linkContents System.String = null optionalposition: 3
linkDestinationName System.String = null optionalposition: 4
public static PdfTableCell Span(IEnumerable<TextRun> runs, Int32 columnSpan, String linkUri = null, String linkContents = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:129
Returns: PdfTableCell

Creates a rich text cell spanning multiple logical columns.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
columnSpan System.Int32 requiredposition: 1
linkUri System.String = null optionalposition: 2
linkContents System.String = null optionalposition: 3
linkDestinationName System.String = null optionalposition: 4
public static PdfTableCell TextCell(String text, String linkUri = null, String linkContents = null, String linkDestinationName = null, String namedDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:120
Returns: PdfTableCell

Creates a single-column text cell.

Parameters

text System.String requiredposition: 0
linkUri System.String = null optionalposition: 1
linkContents System.String = null optionalposition: 2
linkDestinationName System.String = null optionalposition: 3
namedDestinationName System.String = null optionalposition: 4
WithCheckBoxes 2 overloads
public static PdfTableCell WithCheckBoxes(IEnumerable<TextRun> runs, IEnumerable<PdfTableCellCheckBox> checkBoxes, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:138
Returns: PdfTableCell

Creates a table cell with rich text and simple AcroForm check boxes.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} requiredposition: 1
columnSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
rowSpan System.Int32 = 1 optionalposition: 5
linkDestinationName System.String = null optionalposition: 6
public static PdfTableCell WithCheckBoxes(String text, IEnumerable<PdfTableCellCheckBox> checkBoxes, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:141
Returns: PdfTableCell

Creates a table cell with plain text and simple AcroForm check boxes.

Parameters

text System.String requiredposition: 0
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} requiredposition: 1
columnSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
rowSpan System.Int32 = 1 optionalposition: 5
linkDestinationName System.String = null optionalposition: 6
WithFormFields 2 overloads
public static PdfTableCell WithFormFields(IEnumerable<TextRun> runs, IEnumerable<PdfTableCellFormField> formFields, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, IEnumerable<PdfTableCellCheckBox> checkBoxes = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:144
Returns: PdfTableCell

Creates a table cell with rich text and simple AcroForm text or choice fields.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
formFields System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellFormField} requiredposition: 1
columnSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
rowSpan System.Int32 = 1 optionalposition: 5
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} = null optionalposition: 6
linkDestinationName System.String = null optionalposition: 7
public static PdfTableCell WithFormFields(String text, IEnumerable<PdfTableCellFormField> formFields, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, IEnumerable<PdfTableCellCheckBox> checkBoxes = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:147
Returns: PdfTableCell

Creates a table cell with plain text and simple AcroForm text or choice fields.

Parameters

text System.String requiredposition: 0
formFields System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellFormField} requiredposition: 1
columnSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
rowSpan System.Int32 = 1 optionalposition: 5
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} = null optionalposition: 6
linkDestinationName System.String = null optionalposition: 7
WithImages 2 overloads
public static PdfTableCell WithImages(IEnumerable<TextRun> runs, IEnumerable<PdfTableCellImage> images, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, IEnumerable<PdfTableCellCheckBox> checkBoxes = null, IEnumerable<PdfTableCellFormField> formFields = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:150
Returns: PdfTableCell

Creates a table cell with rich text and images.

Parameters

runs System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.TextRun} requiredposition: 0
images System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellImage} requiredposition: 1
columnSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
rowSpan System.Int32 = 1 optionalposition: 5
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} = null optionalposition: 6
formFields System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellFormField} = null optionalposition: 7
linkDestinationName System.String = null optionalposition: 8
public static PdfTableCell WithImages(String text, IEnumerable<PdfTableCellImage> images, Int32 columnSpan = 1, String linkUri = null, String linkContents = null, Int32 rowSpan = 1, IEnumerable<PdfTableCellCheckBox> checkBoxes = null, IEnumerable<PdfTableCellFormField> formFields = null, String linkDestinationName = null) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:153
Returns: PdfTableCell

Creates a table cell with plain text and images.

Parameters

text System.String requiredposition: 0
images System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellImage} requiredposition: 1
columnSpan System.Int32 = 1 optionalposition: 2
linkUri System.String = null optionalposition: 3
linkContents System.String = null optionalposition: 4
rowSpan System.Int32 = 1 optionalposition: 5
checkBoxes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellCheckBox} = null optionalposition: 6
formFields System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfTableCellFormField} = null optionalposition: 7
linkDestinationName System.String = null optionalposition: 8
public PdfTableCell WithNamedDestination(String namedDestinationName) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:156
Returns: PdfTableCell

Returns a copy of this cell with a PDF named destination defined at the cell.

Parameters

namedDestinationName System.String requiredposition: 0
public PdfTableCell WithNoWrap(Boolean noWrap = true) #
OfficeIMO.Pdf/Model/PdfTableCell.cs:162
Returns: PdfTableCell

Returns a copy that keeps each cell paragraph on one visual line. When the containing table enables text shrinking, the renderer reduces the font before clipping.

Parameters

noWrap System.Boolean = true optionalposition: 0

Properties

public String Text { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:83

Cell text content.

public IReadOnlyList<TextRun> Runs { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:86

Rich text runs for the cell. Plain text cells expose a single unstyled run.

public Int32 ColumnSpan { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:89

Number of logical columns covered by this cell.

public Int32 RowSpan { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:92

Number of logical rows covered by this cell.

public String LinkUri { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:95

Optional absolute URI or catalog-base-relative URI linked from this cell.

public String LinkDestinationName { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:98

Optional PDF named destination linked from this cell.

public String NamedDestinationName { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:101

Optional PDF named destination defined at this cell.

public String LinkContents { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:104

Optional PDF annotation contents metadata for the cell link.

public IReadOnlyList<PdfTableCellCheckBox> CheckBoxes { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:107

Simple AcroForm check boxes rendered inside this cell.

public IReadOnlyList<PdfTableCellFormField> FormFields { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:110

Simple AcroForm text and choice fields rendered inside this cell.

public IReadOnlyList<PdfTableCellImage> Images { get; } #
OfficeIMO.Pdf/Model/PdfTableCell.cs:113

Images rendered inside this cell.