API Documentation > Interfaces > Interface SectionEntityText
Interface SectionEntityText

package com.ptc.wfc.wfcSection;

public interface
SectionEntityText
extends
com.ptc.wfc.wfcSection.SectionEntity


Description
This interface represents Text entity used in sections
User Guide References:
Methods Inherited from Interface com.ptc.wfc.wfcSection.SectionEntity :
Method Summary
int
Get method for attribute "AlongCurveId"
Identifier of the curve along which text is placed.
double
Get method for attribute "AspectRatio"
Aspect ratio of the text.
String
Get method for attribute "Comment"
text to Enter
Get method for attribute "FirstCorner"
First corner of text box.
String
Get method for attribute "FontName"
Font name.
Get method for attribute "HorizontalAlignment"
Horizontal alignment of the text. Denotes the place of the starting point relative to the text.
boolean
Get method for attribute "Kerning"
Whether kerning is enabled for the text.
Get method for attribute "SecondCorner"
Second corner of text box.
Get method for attribute "SecondPoint"
Second point of the cursor construction line.
double
Get method for attribute "SlantAngle"
Slant angle of the text in degrees.
double
Get method for attribute "Spacing"
Spacing between characters.
Get method for attribute "StartingPoint"
Starting point of the cursor construction line.
Get method for attribute "VerticalAlignment"
Vertical alignment of the text. Denotes the place of the starting point relative to the text.
void
SetAlongCurveId (int value)
Set method for attribute "AlongCurveId"
Identifier of the curve along which text is placed.
void
SetAspectRatio (double value)
Set method for attribute "AspectRatio"
Aspect ratio of the text.
void
SetComment (String value)
Set method for attribute "Comment"
text to Enter
void
Set method for attribute "FirstCorner"
First corner of text box.
void
SetFontName (String value)
Set method for attribute "FontName"
Font name.
void
Set method for attribute "HorizontalAlignment"
Horizontal alignment of the text. Denotes the place of the starting point relative to the text.
void
SetKerning (boolean value)
Set method for attribute "Kerning"
Whether kerning is enabled for the text.
void
Set method for attribute "SecondCorner"
Second corner of text box.
void
Set method for attribute "SecondPoint"
Second point of the cursor construction line.
void
SetSlantAngle (double value)
Set method for attribute "SlantAngle"
Slant angle of the text in degrees.
void
SetSpacing (double value)
Set method for attribute "Spacing"
Spacing between characters.
void
Set method for attribute "StartingPoint"
Starting point of the cursor construction line.
void
Set method for attribute "VerticalAlignment"
Vertical alignment of the text. Denotes the place of the starting point relative to the text.
Method Detail
GetFirstCorner
GetFirstCorner
()
SetFirstCorner
void
SetFirstCorner
(Point2D value)
First corner of text box.
If using the new text positioning fields (StartingPoint, SecondPoint, etc.), both FirstCorner and SecondCorner must be initialized to (0,0). If either is not (0,0), the new fields will be ignored.
User Guide References:
GetSecondCorner
GetSecondCorner
()
SetSecondCorner
void
SetSecondCorner
(Point2D value)
Second corner of text box.
If using the new text positioning fields (StartingPoint, SecondPoint, etc.), both FirstCorner and SecondCorner must be initialized to (0,0). If either is not (0,0), the new fields will be ignored.
User Guide References:
GetComment
String
GetComment
()
SetComment
void
SetComment
(String value)
text to Enter
User Guide References:
GetFontName
String
GetFontName
()
SetFontName
void
SetFontName
(String value)
Font name.
User Guide References:
GetStartingPoint
GetStartingPoint
()
SetStartingPoint
void
SetStartingPoint
(Point2D value)
Starting point of the cursor construction line.
These new text fields are only used if both FirstCorner and SecondCorner are set to (0,0). Otherwise, these fields are ignored.
User Guide References:
GetSecondPoint
GetSecondPoint
()
SetSecondPoint
void
SetSecondPoint
(Point2D value)
Second point of the cursor construction line.
These new text fields are only used if both FirstCorner and SecondCorner are set to (0,0). Otherwise, these fields are ignored.
User Guide References:
GetHorizontalAlignment
GetHorizontalAlignment
()
SetHorizontalAlignment
void
SetHorizontalAlignment
Horizontal alignment of the text. Denotes the place of the starting point relative to the text.
Valid values: TEXT_ALIGN_LEFT (-1, default), TEXT_ALIGN_CENTER (0), TEXT_ALIGN_RIGHT (1).
See Also:
User Guide References:
GetVerticalAlignment
GetVerticalAlignment
()
SetVerticalAlignment
void
SetVerticalAlignment
Vertical alignment of the text. Denotes the place of the starting point relative to the text.
Valid values: TEXT_ALIGN_BOTTOM (-1, default), TEXT_ALIGN_MIDDLE (0), TEXT_ALIGN_TOP (1).
See Also:
User Guide References:
GetAspectRatio
double
GetAspectRatio
()
SetAspectRatio
void
SetAspectRatio
(double value)
Aspect ratio of the text.
Valid range: 0.1 to 10.0. Default is 1.0.
User Guide References:
GetSlantAngle
double
GetSlantAngle
()
SetSlantAngle
void
SetSlantAngle
(double value)
Slant angle of the text in degrees.
Valid range: -60.0 to 60.0 degrees. Default is 0.0.
User Guide References:
GetSpacing
double
GetSpacing
()
SetSpacing
void
SetSpacing
(double value)
Spacing between characters.
Valid range: 0.01 to 100.0. Default is 1.0.
User Guide References:
GetKerning
boolean
GetKerning
()
SetKerning
void
SetKerning
(boolean value)
Whether kerning is enabled for the text.
Boolean value. Default is false.
User Guide References:
GetAlongCurveId
int
GetAlongCurveId
()
SetAlongCurveId
void
SetAlongCurveId
(int value)
Identifier of the curve along which text is placed.
Set to -1 if not placing text along a curve.
User Guide References:
Was this helpful?