Foxit PDF SDK
fsdk.TableBorderInfo Class Reference

Public Member Functions

def GetColor ()
 Get the table border color. More...
 
def GetDash_phase ()
 Get dash phase. More...
 
def GetDashes ()
 Get a dash array that represents the dash patterns. More...
 
def GetLine_width ()
 Get table border line width, in points. More...
 
def GetTable_border_style ()
 Get table border style. More...
 
def SetColor (value)
 Set the table border color. More...
 
def SetDash_phase (value)
 Set dash phase. More...
 
def SetDashes (value)
 Set a dash array that represents the dash patterns. More...
 
def SetLine_width (value)
 Set table border line width, in points. More...
 
def SetTable_border_style (value)
 Set table border style. More...
 

Detailed Description

This class represents table border information.

Member Function Documentation

◆ GetColor()

fsdk.TableBorderInfo.GetColor ( )

Get the table border color.

Returns
The table border color. Format: 0xAARRGGBB.

◆ GetDash_phase()

fsdk.TableBorderInfo.GetDash_phase ( )

Get dash phase.

Returns
Dash phase.It should not be negative. Only useful when parameter style</ i> is fsdk.TableBorderInfoE_TableBorderStyleDashed . Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details.

◆ GetDashes()

fsdk.TableBorderInfo.GetDashes ( )

Get a dash array that represents the dash patterns.

Returns
A dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is fsdk.TableBorderInfoE_TableBorderStyleDashed . Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details.

◆ GetLine_width()

fsdk.TableBorderInfo.GetLine_width ( )

Get table border line width, in points.

Returns
Table border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn.

◆ GetTable_border_style()

fsdk.TableBorderInfo.GetTable_border_style ( )

Get table border style.

Returns
Table border style. Please refer to values starting from fsdk.TableBorderInfoE_TableBorderStyleSolid and this should be one of these values.

◆ SetColor()

fsdk.TableBorderInfo.SetColor (   value)

Set the table border color.

Parameters
[in]valueThe table border color. Format: 0xAARRGGBB.
Returns
None.

◆ SetDash_phase()

fsdk.TableBorderInfo.SetDash_phase (   value)

Set dash phase.

Parameters
[in]valueDash phase.It should not be negative. Only useful when parameter style</ i> is fsdk.TableBorderInfoE_TableBorderStyleDashed . Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details.
Returns
None.

◆ SetDashes()

fsdk.TableBorderInfo.SetDashes (   value)

Set a dash array that represents the dash patterns.

Parameters
[in]valueA dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is fsdk.TableBorderInfoE_TableBorderStyleDashed . Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details.
Returns
None.

◆ SetLine_width()

fsdk.TableBorderInfo.SetLine_width (   value)

Set table border line width, in points.

Parameters
[in]valueTable border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn.
Returns
None.

◆ SetTable_border_style()

fsdk.TableBorderInfo.SetTable_border_style (   value)

Set table border style.

Parameters
[in]valueTable border style. Please refer to values starting from fsdk.TableBorderInfoE_TableBorderStyleSolid and this should be one of these values.
Returns
None.