Aspose.Barcode for Python via Java Generation and Recognition API docs
asposebarcode.Generation.CaptionParameters Class Reference

Caption parameters. More...

Inherits asposebarcode.Assist.BaseJavaClass.

Public Member Functions

def __init__ (self, javaClass)
 
def init (self)
 
def getText (self)
 Caption text. More...
 
def setText (self, value)
 Caption text. More...
 
def getFont (self)
 Caption font. More...
 
def getVisible (self)
 Caption text visibility. More...
 
def setVisible (self, value)
 Caption text visibility. More...
 
def getTextColor (self)
 Caption text color, representation of an RGB tuple. More...
 
def setTextColor (self, value)
 Caption text color, representation of an RGB tuple. More...
 
def getPadding (self)
 Captions paddings. More...
 
def setPadding (self, value)
 Captions paddings. More...
 
def getAlignment (self)
 Caption test horizontal alignment. More...
 
def setAlignment (self, value)
 Caption test horizontal alignment. More...
 
def getNoWrap (self)
 Specify word wraps (line breaks) within text. More...
 
def setNoWrap (self, value)
 Specify word wraps (line breaks) within text. More...
 
- Public Member Functions inherited from asposebarcode.Assist.BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Public Attributes

 font
 
 padding
 
- Public Attributes inherited from asposebarcode.Assist.BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

Caption parameters.

Constructor & Destructor Documentation

◆ __init__()

def asposebarcode.Generation.CaptionParameters.__init__ (   self,
  javaClass 
)

Member Function Documentation

◆ getAlignment()

def asposebarcode.Generation.CaptionParameters.getAlignment (   self)

Caption test horizontal alignment.

Default valueAlignment.Center.

◆ getFont()

def asposebarcode.Generation.CaptionParameters.getFont (   self)

Caption font.

Default value: Arial 8pt regular.

◆ getNoWrap()

def asposebarcode.Generation.CaptionParameters.getNoWrap (   self)

Specify word wraps (line breaks) within text.

Returns
bool

◆ getPadding()

def asposebarcode.Generation.CaptionParameters.getPadding (   self)

Captions paddings.

Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt.

◆ getText()

def asposebarcode.Generation.CaptionParameters.getText (   self)

Caption text.

Default value: empty string.

◆ getTextColor()

def asposebarcode.Generation.CaptionParameters.getTextColor (   self)

Caption text color, representation of an RGB tuple.

Default value (0,0,0).

◆ getVisible()

def asposebarcode.Generation.CaptionParameters.getVisible (   self)

Caption text visibility.

Default value: false.

◆ init()

def asposebarcode.Generation.CaptionParameters.init (   self)

◆ setAlignment()

def asposebarcode.Generation.CaptionParameters.setAlignment (   self,
  value 
)

Caption test horizontal alignment.

Default valueAlignment.Center.

◆ setNoWrap()

def asposebarcode.Generation.CaptionParameters.setNoWrap (   self,
  value 
)

Specify word wraps (line breaks) within text.

◆ setPadding()

def asposebarcode.Generation.CaptionParameters.setPadding (   self,
  value 
)

Captions paddings.

Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt.

◆ setText()

def asposebarcode.Generation.CaptionParameters.setText (   self,
  value 
)

Caption text.

Default value: empty string.

◆ setTextColor()

def asposebarcode.Generation.CaptionParameters.setTextColor (   self,
  value 
)

Caption text color, representation of an RGB tuple.

Default value (0,0,0).

◆ setVisible()

def asposebarcode.Generation.CaptionParameters.setVisible (   self,
  value 
)

Caption text visibility.

Default value: false.

Member Data Documentation

◆ font

asposebarcode.Generation.CaptionParameters.font

◆ padding

asposebarcode.Generation.CaptionParameters.padding