Foxit PDF SDK
FoxitPDFSDKPython2.TableBorderInfo Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def TableBorderInfo ()
 Constructor. More...
 
def Set (table_border_style, line_width, color, dash_phase, dashes)
 Set value. More...
 

Static Public Attributes

 color = _swig_property(_fsdk.TableBorderInfo_color_get, _fsdk.TableBorderInfo_color_set)
 The table border color. Format: 0xAARRGGBB.
 
 dash_phase = _swig_property(_fsdk.TableBorderInfo_dash_phase_get, _fsdk.TableBorderInfo_dash_phase_set)
 Dash phase.It should not be negative. Only useful when parameter style</ i> is FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleDashed . Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details.
 
 dashes = _swig_property(_fsdk.TableBorderInfo_dashes_get, _fsdk.TableBorderInfo_dashes_set)
 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 FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleDashed . Please refer to <PDF Reference 1.7> P211 "dash pattern" for more details.
 
 e_TableBorderStyleDashed = _fsdk.TableBorderInfo_e_TableBorderStyleDashed
 Table border style: Dashed.
 
 e_TableBorderStyleSolid = _fsdk.TableBorderInfo_e_TableBorderStyleSolid
 Table border style: Solid.
 
 line_width = _swig_property(_fsdk.TableBorderInfo_line_width_get, _fsdk.TableBorderInfo_line_width_set)
 Table border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn.
 
 table_border_style = _swig_property(_fsdk.TableBorderInfo_table_border_style_get, _fsdk.TableBorderInfo_table_border_style_set)
 Table border style. Please refer to values starting from FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleSolid and this should be one of these values.
 

Detailed Description

This class represents table border information.

Constructor & Destructor Documentation

◆ TableBorderInfo()

def FoxitPDFSDKPython2.TableBorderInfo.TableBorderInfo ( )

Constructor.

Constructor, with another table border information object.

Constructor, with parameters.

Parameters
[in]table_border_styleTable border style. Please refer to values starting from FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleSolid and this should be one of these values.
[in]line_widthTable border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn.
[in]colorThe table border color. Format: 0xAARRGGBB.
[in]dash_phaseDash phase. Only useful when parameter style is FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleDashed .
[in]dashesA dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleDashed .
[in]table_border_infoAnother table border information object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.TableBorderInfo.Set (   table_border_style,
  line_width,
  color,
  dash_phase,
  dashes 
)

Set value.

Parameters
[in]table_border_styleTable border style. Please refer to values starting from FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleSolid and this should be one of these values.
[in]line_widthTable border line width, in points. This should be a non-negative value. If this value is 0, no border is drawn.
[in]colorThe table border color. Format: 0xAARRGGBB.
[in]dash_phaseDash phase. Only useful when parameter style is FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleDashed .
[in]dashesA dash array that represents the dash patterns. The value of each element in this array should not be negative. Only useful when style is FoxitPDFSDKPython2.TableBorderInfo.e_TableBorderStyleDashed .
Returns
None.