Foxit PDF SDK
fsdk.TableCellData Class Reference

Public Member Functions

def GetCell_fill_color ()
 Get the fill color of cell. More...
 
def GetCell_image ()
 Get the image content of cell. More...
 
def GetCell_margin ()
 Get the cell margin between the content and cell border. More...
 
def GetCell_text ()
 Get the text content of cell. More...
 
def GetCell_text_style ()
 Get the style of cell text. More...
 
def Set (cell_text_style, cell_fill_color, cell_text, cell_image, cell_margin)
 Set value. More...
 
def SetCell_fill_color (value)
 Set the fill color of cell. More...
 
def SetCell_image (value)
 Set the image content of cell. More...
 
def SetCell_margin (value)
 Set the cell margin between the content and cell border. More...
 
def SetCell_text (value)
 Set the text content of cell. More...
 
def SetCell_text_style (value)
 Set the style of cell text. More...
 

Detailed Description

This class represents table cell data.

Member Function Documentation

◆ GetCell_fill_color()

fsdk.TableCellData.GetCell_fill_color ( )

Get the fill color of cell.

Returns
The fill color of cell. Format: 0xAARRGGBB.

◆ GetCell_image()

fsdk.TableCellData.GetCell_image ( )

Get the image content of cell.

Note
Currently, it is not supported for text and image to exist in the same cell. For merged cells, their contents is text or image which is set in the first merged cell.
Returns
The image content of cell.

◆ GetCell_margin()

fsdk.TableCellData.GetCell_margin ( )

Get the cell margin between the content and cell border.

Note
This value does not represent a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a table cell. The value should not be negative and should not be bigger than the cell's height or width.
Returns
The cell margin between the content and cell border.

◆ GetCell_text()

fsdk.TableCellData.GetCell_text ( )

Get the text content of cell.

Note
Currently, it is not supported for text and image to exist in the same cell. For merged cells, their contents is text or image which is set in the first merged cell.
Returns
The text content of cell.

◆ GetCell_text_style()

fsdk.TableCellData.GetCell_text_style ( )

Get the style of cell text.

Returns
The style of cell text.

◆ Set()

def fsdk.TableCellData.Set (   cell_text_style,
  cell_fill_color,
  cell_text,
  cell_image,
  cell_margin 
)

Set value.

Parameters
[in]cell_text_styleThe style of cell text.
[in]cell_fill_colorThe fill color of cell. Format: 0xAARRGGBB.
[in]cell_textThe text content of cell.
[in]cell_imageThe image content of cell.
[in]cell_marginThe cell margin.
Returns
None.

◆ SetCell_fill_color()

fsdk.TableCellData.SetCell_fill_color (   value)

Set the fill color of cell.

Parameters
[in]valueThe fill color of cell. Format: 0xAARRGGBB.
Returns
None.

◆ SetCell_image()

fsdk.TableCellData.SetCell_image (   value)

Set the image content of cell.

Note
Currently, it is not supported for text and image to exist in the same cell. For merged cells, their contents is text or image which is set in the first merged cell.
Parameters
[in]valueThe image content of cell.
Returns
None.

◆ SetCell_margin()

fsdk.TableCellData.SetCell_margin (   value)

Set the cell margin between the content and cell border.

Note
This value does not represent a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a table cell. The value should not be negative and should not be bigger than the cell's height or width.
Parameters
[in]valueThe cell margin between the content and cell border.
Returns
None.

◆ SetCell_text()

fsdk.TableCellData.SetCell_text (   value)

Set the text content of cell.

Note
Currently, it is not supported for text and image to exist in the same cell. For merged cells, their contents is text or image which is set in the first merged cell.
Parameters
[in]valueThe text content of cell.
Returns
None.

◆ SetCell_text_style()

fsdk.TableCellData.SetCell_text_style (   value)

Set the style of cell text.

Parameters
[in]valueThe style of cell text.
Returns
None.