public class Caption extends Object
The text caption shown in the barcode image. There are two captions: CaptionBelow and CaptionAbove
Constructor and Description |
---|
Caption()
Initializes a new instance of the
Caption class with default value. |
Caption(String text)
Initializes a new instance of the
Caption class with specified text. |
Caption(String text,
boolean visible,
int alignment,
float space,
Color color,
Font font) |
Modifier and Type | Method and Description |
---|---|
Caption |
copy()
Get a new copy of the caption instance.
|
void |
dispose()
Dispose the Caption instance
|
Font |
getFont()
Gets the
System.Drawing.Fontfont of the Caption . |
Color |
getForeColor()
Gets the
System.Drawing.Colorforecolor of the Caption . |
float |
getSpace()
Gets the space between the caption and the barcode,
and the space between border and the caption
|
String |
getText()
Gets the content of the caption.
|
int |
getTextAlign()
Gets the text
System.Drawing.StringAlignmentalignment of the caption. |
boolean |
getVisible()
Gets a value indicates whether the
Caption is visible. |
void |
setFont(Font value)
Sets the
System.Drawing.Fontfont of the Caption . |
void |
setForeColor(Color value)
Sets the
System.Drawing.Colorforecolor of the Caption . |
void |
setSpace(float value)
Sets the space between the caption and the barcode,
and the space between border and the caption
|
void |
setText(String value)
Sets the content of the caption.
|
void |
setTextAlign(int value)
Sets the text
System.Drawing.StringAlignmentalignment of the caption. |
void |
setVisible(boolean value)
Sets a value indicates whether the
Caption is visible. |
public Caption()
Initializes a new instance of the Caption
class with default value.
public Caption(String text)
Initializes a new instance of the Caption
class with specified text.
text
- The text content of the caption objectpublic Caption copy()
Get a new copy of the caption instance.
public boolean getVisible()
Gets a value indicates whether the Caption
is visible.
public void setVisible(boolean value)
Sets a value indicates whether the Caption
is visible.
public Color getForeColor()
Gets the System.Drawing.Colorforecolor
of the Caption
.
public void setForeColor(Color value)
Sets the System.Drawing.Colorforecolor
of the Caption
.
public Font getFont()
Gets the System.Drawing.Fontfont
of the Caption
.
public void setFont(Font value)
Sets the System.Drawing.Fontfont
of the Caption
.
public float getSpace()
Gets the space between the caption and the barcode, and the space between border and the caption
com.aspose.ms.System.ArgumentException
- <p>The <b>Space</b> parameter value is less than 0.</p>
<b>space</b>
for the caption is indicated by the System.Drawing.GraphicsUnitGraphicsUnit
.
public void setSpace(float value)
Sets the space between the caption and the barcode, and the space between border and the caption
public int getTextAlign()
Gets the text System.Drawing.StringAlignmentalignment
of the caption.
e.g. when the text is writing from left to right, StringAlignment.Near means the Caption will be aligned to the left
public void setTextAlign(int value)
Sets the text System.Drawing.StringAlignmentalignment
of the caption.
e.g. when the text is writing from left to right, StringAlignment.Near means the Caption will be aligned to the left
public String getText()
Gets the content of the caption.
public void setText(String value)
Sets the content of the caption.
public void dispose()
Dispose the Caption instance
Copyright (c) 2002-2014 Aspose Pty Ltd. All Rights Reserved.