PDFFlowTableStringCell¶

Namespace: O2S.Components.PDF4NET.FlowDocument

Defines a cell that contains a string.

public class PDFFlowTableStringCell : PDFFlowTableCell

Inheritance Object → PDFFlowTableCell → PDFFlowTableStringCell

Constructors¶

PDFFlowTableStringCell()¶

Initializes a new PDFFlowTableStringCell object.

public PDFFlowTableStringCell()

PDFFlowTableStringCell(String)¶

Initializes a new PDFFlowTableStringCell object.

public PDFFlowTableStringCell(string content)

Parameters

content String
The cell content.

PDFFlowTableStringCell(String, Boolean)¶

Initializes a new PDFFlowTableStringCell object.

public PDFFlowTableStringCell(string content, bool multiline)

Parameters

content String
The cell content.

multiline Boolean
True if the cell content should be wrapped on multiple lines.

PDFFlowTableStringCell(PDFFlowTableStringCell)¶

Initializes a new PDFFlowTableStringCell object with a copy of another cell.

public PDFFlowTableStringCell(PDFFlowTableStringCell source)

Parameters

source PDFFlowTableStringCell
Source cell.

Properties¶

Background¶

Gets or sets the cell background.

public PDFBrush Background { get; set; }

Property Value

PDFBrush
A PDFBrush object that specifies how the cell background is filled.

Borders¶

Gets or sets the cell borders.

public PDFFlowContentBorders Borders { get; set; }

Property Value

PDFFlowContentBorders
A PDFFlowContentBorders object specifying how the top, right, bottom and left borders are drawn.

Color¶

Gets or sets the content color.

public PDFBrush Color { get; set; }

Property Value

PDFBrush
The color used to display the cell content.

ColSpan¶

Gets or sets the number of columns this cell spans on.

public uint ColSpan { get; set; }

Property Value

UInt32
The number of columns on which this cell spans.

Content¶

Gets or sets the cell content.

public string Content { get; set; }

Property Value

String

Font¶

Gets or sets the content font.

public PDFFont Font { get; set; }

Property Value

PDFFont
The font used to display the cell content.

ForceLongWordsWrap¶

Gets or sets a flag indicating whether long words should wrap if they do not fit entirely on a single line.

public bool ForceLongWordsWrap { get; set; }

Property Value

Boolean
True if long words are wrapped at character level if they do not fit entirely on a single line.

Remarks

This property has effect if PDFFlowTableStringCell.Multiline property is set to true.

HorizontalAlign¶

Gets or sets the horizontal align.

public PDFGraphicAlign HorizontalAlign { get; set; }

Property Value

PDFGraphicAlign
The default horizontal alignment for the cells in the column.

InnerMargins¶

Gets or sets the cell inner margins.

public PDFFlowContentMargins InnerMargins { get; set; }

Property Value

PDFFlowContentMargins
A PDFFlowContentMargins object specifying the cell inner margins.

Multiline¶

Gets or sets a value indicating whether the cell content should be wrapped on multiple lines.

public bool Multiline { get; set; }

Property Value

Boolean
If true the cell content is wrapped on multiple lines, otherwise it is displayed on a single line even if it is clipped. Default is false.

OverflowMode¶

Gets or sets the cell overflow mode.

public PDFFlowTableStringCellOverflowMode OverflowMode { get; set; }

Property Value

PDFFlowTableStringCellOverflowMode
A PDFFlowTableStringCellOverflowMode enum member specifying how cell content overflows.

Remarks

This property is considered only when PDFFlowTableStringCell.Multiline property is false.

Row¶

Gets the row this cell belongs to.

public PDFFlowTableRow Row { get; internal set; }

Property Value

PDFFlowTableRow
The row that owns the cell.

RowSpan¶

Gets or sets the number of rows this cell spans on.

public uint RowSpan { get; set; }

Property Value

UInt32
The number of rows on which this cell spans.

StructureElement¶

Gets or sets the structure element.

public PDFStructureElement StructureElement { get; set; }

Property Value

PDFStructureElement
The PDFStructureElement object associated with this cell object.

Tag¶

Gets or sets an arbitrary object value that can be used to store custom information about this element.

public object Tag { get; set; }

Property Value

Object
The intended value.

Remarks

This property is analogous to Tag properties in other Microsoft programming models. Tag is intended to provide a pre-existing property location where you can store some basic custom information about any PDFFlowContent without requiring you to subclass a cell object.

TextDirection¶

Gets or sets the text direction.

public PDFTextDirection TextDirection { get; set; }

Property Value

PDFTextDirection
A PDFTextDirection enum member specifying the direction of the text within the cell.

VerticalAlign¶

Gets or sets the vertical align.

public PDFGraphicAlign VerticalAlign { get; set; }

Property Value

PDFGraphicAlign
The default vertical alignment for the cells in the column.