Char

Inheritance: java.lang.Object

public class Char

Contains the formatting attributes for the shape’s text, such as font, color, text style, case, position relative to the baseline, and point size.

Constructors

Constructor Description
Char() Constructor.

Methods

Method Description
deepClone() Creates deep copy of this instance.
equals(Object arg0)
getAsianFont() Specifies the ID number of the font used to format text containing Asian characters.
getAsianFontName() It specified the asian font name of the font used to format the text.It is using for visio 2013
getCase() Determines the case of a shape’s text.
getClass()
getColor() When contained in a Char element, the Color element.
getColorTrans() Determines the degree of transparency for a layer or shape’s text color, from 0 (completely opaque) to 1 (completely transparent).
getComplexScriptFont() Contains the number of the font used to format text composed of complex script characters.
getComplexScriptFontName() It specified the ComplexScript font name of the font used to format the text.It is using for visio 2013
getComplexScriptSize() The size of the font used to format text composed of complex script characters.
getDblUnderline() Specifies whether the range of text has a double underline below it.
getDel() A flag indicating whether the element has been deleted locally.
getDoubleStrikethrough() Determines whether text is formatted as double strikethrough.
getFont() Specifies the ID number of the font used to format the text.
getFontName() It specified the font name of the font used to format the text.It is using for visio 2013
getFontScale() Specifies the font width.
getHighlight() It specified highlight.
getIX() The zero-based index of the element within its parent element.
getLangID() Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
getLetterspace() Specifies the amount of space between two or more characters.
getLocale() It specified the locale of the text run for spell-checking purposes.
getLocalizeFont() Specifies whether the shape text should be localized (translated into another language).
getOverline() Specifies whether the text has a line above it.
getPerpendicular() It specified whether a text field appears perpendicular to the other text in a text block.
getPos() Specifies the position of the shape’s text relative to the baseline.
getRTLText() Determines if the text direction of the current character run is left to right or right to left.
getSize() Specifies the size of the text in the shape’s text block.
getStrikethru() Specifies whether the text is formatted as strikethrough.
getStyle() Specifies the character formatting applied to a range of text in the shape’s text block.
getUseVertical() Determines whether the character run is vertical or horizontal.
hashCode()
isBold() Indicating whether the font is bold.
isDoubleStrikethrough() Indicating whether the font is doubleStrikethrough.
isDoubleUnderline() Indicating whether the font is double underline.
isItalic() Indicating whether the font is italic.
isStrikethrough() Indicating whether the font is strikethrough.
isSubscript() Indicating whether the font is subscript.
isSuperscript() Indicating whether the font is superscript.
isUnderline() Indicating whether the font is underline.
notify()
notifyAll()
setAsianFont(IntValue value) For the description of this property, please see getAsianFont()
setAsianFontName(StrValue value) For the description of this property, please see getAsianFontName()
setCase(Case value) For the description of this property, please see getCase()
setColor(ColorValue value) For the description of this property, please see getColor()
setColorTrans(DoubleValue value) For the description of this property, please see getColorTrans()
setComplexScriptFont(IntValue value) For the description of this property, please see getComplexScriptFont()
setComplexScriptFontName(StrValue value) For the description of this property, please see getComplexScriptFontName()
setComplexScriptSize(DoubleValue value) For the description of this property, please see getComplexScriptSize()
setDblUnderline(BoolValue value) For the description of this property, please see getDblUnderline()
setDel(int value) For the description of this property, please see getDel()
setDoubleStrikethrough(BoolValue value) For the description of this property, please see getDoubleStrikethrough()
setFont(IntValue value) For the description of this property, please see getFont()
setFontName(StrValue value) For the description of this property, please see getFontName()
setFontScale(DoubleValue value) For the description of this property, please see getFontScale()
setHighlight(BoolValue value) For the description of this property, please see getHighlight()
setIX(int value) For the description of this property, please see getIX()
setLangID(IntValue value) For the description of this property, please see getLangID()
setLetterspace(DoubleValue value) For the description of this property, please see getLetterspace()
setLocale(StrValue value) For the description of this property, please see getLocale()
setLocalizeFont(LocalizeFont value) For the description of this property, please see getLocalizeFont()
setOverline(BoolValue value) For the description of this property, please see getOverline()
setPerpendicular(StrValue value) For the description of this property, please see getPerpendicular()
setPos(Pos value) For the description of this property, please see getPos()
setRTLText(BoolValue value) For the description of this property, please see getRTLText()
setSize(DoubleValue value) For the description of this property, please see getSize()
setStrikethru(BoolValue value) For the description of this property, please see getStrikethru()
setStyle(Style value) For the description of this property, please see getStyle()
setUseVertical(BoolValue value) For the description of this property, please see getUseVertical()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Char()

public Char()

Constructor.

deepClone()

public Object deepClone()

Creates deep copy of this instance.

Returns: java.lang.Object -

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getAsianFont()

public IntValue getAsianFont()

Specifies the ID number of the font used to format text containing Asian characters.

Returns: IntValue

getAsianFontName()

public StrValue getAsianFontName()

It specified the asian font name of the font used to format the text.It is using for visio 2013

Returns: StrValue

getCase()

public Case getCase()

Determines the case of a shape’s text.

Returns: Case

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColor()

public ColorValue getColor()

When contained in a Char element, the Color element.

Returns: ColorValue

getColorTrans()

public DoubleValue getColorTrans()

Determines the degree of transparency for a layer or shape’s text color, from 0 (completely opaque) to 1 (completely transparent).

Returns: DoubleValue

getComplexScriptFont()

public IntValue getComplexScriptFont()

Contains the number of the font used to format text composed of complex script characters. Complex scripts are languages whose characters require ligation or shaping, such as the right-to-left languages (Arabic, Farsi, Hebrew, and Urdu) and several South Asian languages.

Returns: IntValue

getComplexScriptFontName()

public StrValue getComplexScriptFontName()

It specified the ComplexScript font name of the font used to format the text.It is using for visio 2013

Returns: StrValue

getComplexScriptSize()

public DoubleValue getComplexScriptSize()

The size of the font used to format text composed of complex script characters. Complex scripts are languages whose characters require ligation or shaping, such as the right-to-left languages (Arabic, Farsi, Hebrew, and Urdu) and several South Asian languages.

Returns: DoubleValue

getDblUnderline()

public BoolValue getDblUnderline()

Specifies whether the range of text has a double underline below it.

Returns: BoolValue

getDel()

public int getDel()

A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally.

Returns: int

getDoubleStrikethrough()

public BoolValue getDoubleStrikethrough()

Determines whether text is formatted as double strikethrough.

Returns: BoolValue

getFont()

public IntValue getFont()

Specifies the ID number of the font used to format the text.

Returns: IntValue

getFontName()

public StrValue getFontName()

It specified the font name of the font used to format the text.It is using for visio 2013

Returns: StrValue

getFontScale()

public DoubleValue getFontScale()

Specifies the font width.

Returns: DoubleValue

getHighlight()

public BoolValue getHighlight()

It specified highlight.

Returns: BoolValue

getIX()

public int getIX()

The zero-based index of the element within its parent element.

Returns: int

getLangID()

public IntValue getLangID()

Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered. For a list of languages supported by Microsoft Office applications and their corresponding language IDs, see the DocLangID element.

Returns: IntValue

getLetterspace()

public DoubleValue getLetterspace()

Specifies the amount of space between two or more characters. Space can be added or subtracted in 1/20th point increments.

Returns: DoubleValue

getLocale()

public StrValue getLocale()

It specified the locale of the text run for spell-checking purposes.

Returns: StrValue

getLocalizeFont()

public LocalizeFont getLocalizeFont()

Specifies whether the shape text should be localized (translated into another language).

Returns: LocalizeFont

getOverline()

public BoolValue getOverline()

Specifies whether the text has a line above it.

Returns: BoolValue

getPerpendicular()

public StrValue getPerpendicular()

It specified whether a text field appears perpendicular to the other text in a text block.

Returns: StrValue

getPos()

public Pos getPos()

Specifies the position of the shape’s text relative to the baseline.

Returns: Pos

getRTLText()

public BoolValue getRTLText()

Determines if the text direction of the current character run is left to right or right to left.

Returns: BoolValue

getSize()

public DoubleValue getSize()

Specifies the size of the text in the shape’s text block.

Returns: DoubleValue

getStrikethru()

public BoolValue getStrikethru()

Specifies whether the text is formatted as strikethrough.

Returns: BoolValue

getStyle()

public Style getStyle()

Specifies the character formatting applied to a range of text in the shape’s text block.

Returns: Style

getUseVertical()

public BoolValue getUseVertical()

Determines whether the character run is vertical or horizontal.

Returns: BoolValue

hashCode()

public native int hashCode()

Returns: int

isBold()

public boolean isBold()

Indicating whether the font is bold.

Returns: boolean

isDoubleStrikethrough()

public boolean isDoubleStrikethrough()

Indicating whether the font is doubleStrikethrough.

Returns: boolean

isDoubleUnderline()

public boolean isDoubleUnderline()

Indicating whether the font is double underline.

Returns: boolean

isItalic()

public boolean isItalic()

Indicating whether the font is italic.

Returns: boolean

isStrikethrough()

public boolean isStrikethrough()

Indicating whether the font is strikethrough.

Returns: boolean

isSubscript()

public boolean isSubscript()

Indicating whether the font is subscript.

Returns: boolean

isSuperscript()

public boolean isSuperscript()

Indicating whether the font is superscript.

Returns: boolean

isUnderline()

public boolean isUnderline()

Indicating whether the font is underline.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAsianFont(IntValue value)

public void setAsianFont(IntValue value)

For the description of this property, please see getAsianFont()

Parameters:

Parameter Type Description
value IntValue

setAsianFontName(StrValue value)

public void setAsianFontName(StrValue value)

For the description of this property, please see getAsianFontName()

Parameters:

Parameter Type Description
value StrValue

setCase(Case value)

public void setCase(Case value)

For the description of this property, please see getCase()

Parameters:

Parameter Type Description
value Case

setColor(ColorValue value)

public void setColor(ColorValue value)

For the description of this property, please see getColor()

Parameters:

Parameter Type Description
value ColorValue

setColorTrans(DoubleValue value)

public void setColorTrans(DoubleValue value)

For the description of this property, please see getColorTrans()

Parameters:

Parameter Type Description
value DoubleValue

setComplexScriptFont(IntValue value)

public void setComplexScriptFont(IntValue value)

For the description of this property, please see getComplexScriptFont()

Parameters:

Parameter Type Description
value IntValue

setComplexScriptFontName(StrValue value)

public void setComplexScriptFontName(StrValue value)

For the description of this property, please see getComplexScriptFontName()

Parameters:

Parameter Type Description
value StrValue

setComplexScriptSize(DoubleValue value)

public void setComplexScriptSize(DoubleValue value)

For the description of this property, please see getComplexScriptSize()

Parameters:

Parameter Type Description
value DoubleValue

setDblUnderline(BoolValue value)

public void setDblUnderline(BoolValue value)

For the description of this property, please see getDblUnderline()

Parameters:

Parameter Type Description
value BoolValue

setDel(int value)

public void setDel(int value)

For the description of this property, please see getDel()

Parameters:

Parameter Type Description
value int

setDoubleStrikethrough(BoolValue value)

public void setDoubleStrikethrough(BoolValue value)

For the description of this property, please see getDoubleStrikethrough()

Parameters:

Parameter Type Description
value BoolValue

setFont(IntValue value)

public void setFont(IntValue value)

For the description of this property, please see getFont()

Parameters:

Parameter Type Description
value IntValue

setFontName(StrValue value)

public void setFontName(StrValue value)

For the description of this property, please see getFontName()

Parameters:

Parameter Type Description
value StrValue

setFontScale(DoubleValue value)

public void setFontScale(DoubleValue value)

For the description of this property, please see getFontScale()

Parameters:

Parameter Type Description
value DoubleValue

setHighlight(BoolValue value)

public void setHighlight(BoolValue value)

For the description of this property, please see getHighlight()

Parameters:

Parameter Type Description
value BoolValue

setIX(int value)

public void setIX(int value)

For the description of this property, please see getIX()

Parameters:

Parameter Type Description
value int

setLangID(IntValue value)

public void setLangID(IntValue value)

For the description of this property, please see getLangID()

Parameters:

Parameter Type Description
value IntValue

setLetterspace(DoubleValue value)

public void setLetterspace(DoubleValue value)

For the description of this property, please see getLetterspace()

Parameters:

Parameter Type Description
value DoubleValue

setLocale(StrValue value)

public void setLocale(StrValue value)

For the description of this property, please see getLocale()

Parameters:

Parameter Type Description
value StrValue

setLocalizeFont(LocalizeFont value)

public void setLocalizeFont(LocalizeFont value)

For the description of this property, please see getLocalizeFont()

Parameters:

Parameter Type Description
value LocalizeFont

setOverline(BoolValue value)

public void setOverline(BoolValue value)

For the description of this property, please see getOverline()

Parameters:

Parameter Type Description
value BoolValue

setPerpendicular(StrValue value)

public void setPerpendicular(StrValue value)

For the description of this property, please see getPerpendicular()

Parameters:

Parameter Type Description
value StrValue

setPos(Pos value)

public void setPos(Pos value)

For the description of this property, please see getPos()

Parameters:

Parameter Type Description
value Pos

setRTLText(BoolValue value)

public void setRTLText(BoolValue value)

For the description of this property, please see getRTLText()

Parameters:

Parameter Type Description
value BoolValue

setSize(DoubleValue value)

public void setSize(DoubleValue value)

For the description of this property, please see getSize()

Parameters:

Parameter Type Description
value DoubleValue

setStrikethru(BoolValue value)

public void setStrikethru(BoolValue value)

For the description of this property, please see getStrikethru()

Parameters:

Parameter Type Description
value BoolValue

setStyle(Style value)

public void setStyle(Style value)

For the description of this property, please see getStyle()

Parameters:

Parameter Type Description
value Style

setUseVertical(BoolValue value)

public void setUseVertical(BoolValue value)

For the description of this property, please see getUseVertical()

Parameters:

Parameter Type Description
value BoolValue

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter Type Description
arg0 long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter Type Description
arg0 long
arg1 int