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

Caption parameters. More...

Inherits _MwWrapper.

Public Member Functions

None __init__ (self, _java_class)
 
str __str__ (self)
 String representation of the CaptionParameters object. More...
 
TextAlignment alignment (self)
 Caption test horizontal alignment. More...
 
None alignment (self, TextAlignment value)
 Caption test horizontal alignment. More...
 
Optional[FontUnitfont (self)
 Caption font. More...
 
bool no_wrap (self)
 Specify word wraps (line breaks) within text. More...
 
None no_wrap (self, bool value)
 Specify word wraps (line breaks) within text. More...
 
Optional[Paddingpadding (self)
 Captions paddings. More...
 
None padding (self, Padding value)
 Captions paddings. More...
 
Optional[str] text (self)
 Caption text. More...
 
None text (self, str value)
 Caption text. More...
 
Tuple[int, int, int] text_color (self)
 Caption text color, representation of an RGB tuple. More...
 
None text_color (self, Tuple[int, int, int] value)
 Caption text color, representation of an RGB tuple. More...
 
bool visible (self)
 Caption text visibility. More...
 
None visible (self, bool value)
 Caption text visibility. More...
 

Detailed Description

Caption parameters.

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  _java_class 
)

Member Function Documentation

◆ __str__()

str __str__ (   self)

String representation of the CaptionParameters object.

◆ alignment() [1/2]

TextAlignment alignment (   self)

Caption test horizontal alignment.

Default valueAlignment.Center.

◆ alignment() [2/2]

None alignment (   self,
TextAlignment  value 
)

Caption test horizontal alignment.

Default valueAlignment.Center.

◆ font()

Optional[FontUnit] font (   self)

Caption font.

Default value: Arial 8pt regular.

◆ no_wrap() [1/2]

bool no_wrap (   self)

Specify word wraps (line breaks) within text.

Returns
bool

◆ no_wrap() [2/2]

None no_wrap (   self,
bool  value 
)

Specify word wraps (line breaks) within text.

◆ padding() [1/2]

Optional[Padding] padding (   self)

Captions paddings.

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

◆ padding() [2/2]

None padding (   self,
Padding  value 
)

Captions paddings.

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

◆ text() [1/2]

Optional[str] text (   self)

Caption text.

Default value: empty string.

◆ text() [2/2]

None text (   self,
str  value 
)

Caption text.

Default value: empty string.

◆ text_color() [1/2]

Tuple[int, int, int] text_color (   self)

Caption text color, representation of an RGB tuple.

Default value (0,0,0).

◆ text_color() [2/2]

None text_color (   self,
Tuple[int, int, int]  value 
)

Caption text color, representation of an RGB tuple.

Default value (0,0,0).

◆ visible() [1/2]

bool visible (   self)

Caption text visibility.

Default value: false.

◆ visible() [2/2]

None visible (   self,
bool  value 
)

Caption text visibility.

Default value: false.