Property name |
Data Type |
Description |
---|---|---|
ColGapWidth |
int |
Gap between columns (0 to 50 inches). |
ColumnsAreBalanced |
int |
1 if terminal and underfilled columns in the flow are balanced. |
FirstAFrame |
First anchored frame in the text frame (FO_AFrame ID). |
|
FirstCell |
First table cell in the text frame (FO_Cell ID). |
|
FirstFn |
First footnote in the text frame (FO_Fn ID). |
|
FirstPgf |
First paragraph in the text frame (FO_Pgf ID). |
|
FirstSubCol |
First column in the text frame (FO_SubCol ID). |
|
Flow |
Flow containing the text frame (FO_Flow ID). |
|
GraphicIsButton |
int |
1 if the text frame is a hypertext button. |
LastAFrame |
Last anchored frame in the text frame (FO_AFrame ID). |
|
LastCell |
Last table cell in the text frame (FO_Cell ID). |
|
LastFn |
Last footnote in the text frame (FO_Fn ID). |
|
LastPgf |
Last paragraph in the text frame (FO_Pgf ID). |
|
LastSubCol |
Last column in the text frame (FO_SubCol ID). |
|
NextTextFrameInFlow |
Next text frame in the flow (FO_TextFrame ID). |
|
NumColumns |
int |
The number of columns in the underlying column grid (1–10). |
PrevTextFrameInFlow |
Previous text frame in the flow (FO_TextFrame ID). |
|
SideHeadGap |
int |
Gap between side head area and body text area (0 to 50 inches). |
SideHeadPlacement |
int |
Placement of side heads relative to columns in the text frame: •Constants.FV_SH_LEFT (0x00) •Constants.FV_SH_RIGHT (0x01) •Constants.FV_SH_INSIDE (0x02) •Constants.FV_SH_OUTSIDE (0x03) |
SideHeadWidth |
int |
Width of side head area for the text frame (0 to 50 inches). |
Angle |
int |
Indicates the angle of rotation of the graphic object. |
ArrowBaseAngle |
int |
Denotes the arrowhead base angle in degrees. |
ArrowLength |
int |
Denotes the arrowhead length (always rounded down to the nearest 1/256 point). |
ArrowScaleFactor |
int |
Indicates the factor by which the arrowhead is scaled as line width changes (always rounded down to nearest 1/16 point). It is not used if the ArrowScaleHead property is False. |
ArrowScaleHead |
int |
Set to 1 if arrowhead is scaled as the line width changes. Set to 0, otherwise. |
ArrowTipAngle |
int |
Denotes the arrowhead tip angle in degrees. |
ArrowType |
int |
Denotes the style of the arrowhead. Possible values are: •Constants.FV_ARROW_STICK (0x1) •Constants.FV_ARROW_HOLLOW (0x2) •Constants.FV_ARROW_FILLED (0x3) |
BorderWidth |
int |
Indicates the border width specified in points. The permissible range is 0.015 pt to 360 points. |
Color |
Denotes the spot color. |
|
Dash |
Specifies a dash pattern that is repeated for the length of an object's border. The pattern is stored in a MetricsT structure. The 0th element of the MetricsT.MetricsT_val array stores the length of the first dash; the 1st element stores the following space; the 2nd element stores the next dash; and so on for an even number of elements. |
|
Fill |
int |
Denotes the fill pattern (numbers between 0 and 15). Constants are provided for fill patterns 0, 7 and 15, as follows: •Constants.FV_FILL_BLACK (0) •Constants.FV_FILL_WHITE (7) •Constants.FV_FILL_CLEAR (15) |
FrameParent |
FMObject |
Denotes the frame containing the graphic object. |
GraphicCantBeSelected |
int |
Set to 1 if the graphic object cannot be selected. Set to 0, otherwise. |
GraphicIsSelected |
int |
Set to 1, if the graphic object is selected. Else, set to 0. |
GroupParent |
Specifies the group to which the object belongs. Note: Anchored frames do NOT have this property. |
|
HeadArrow |
int |
Set to 1 if the line has an arrow head. Set to 0, otherwise. |
Height |
int |
Denotes the height of the object denoted in points. The permissible range is from 0.125 points to 3600 points. |
HotspotCmdStr |
StringT |
The command string for a hotspot. Thismust be a valid hypertext command string. |
HotspotTitle |
StringT |
The tooltip text for the hotspot in the outputs that support it (for example HTML). This property is 0ptional. |
IsHotspot |
Bool |
Whether the object is a hotspot or not. If this property is turned off, the object is no longer a hotspot even if command string is non-empty. |
LineCap |
int |
Specifies the type of the end of the line. The possible values are: •Constants.FV_CAP_BUTT (0x00) •Constants.FV_CAP_ROUND (0x01) •Constants.FV_CAP_SQUARE (0x02) |
LocX |
int |
Specifies the distance of the object from the left side of the parent frame (in inches). The permissible range is –216 inches to 216 inches. If the graphic object is an anchored frame, the distance is automatically calculated from the left side of the page frame. You cannot set this value manually for anchored frames. |
LocY |
int |
Distance of the object from the top of the parent frame (in inches) The permissible range is –216 inches to 216 inches. If the graphic object is an anchored frame, the distance is automatically calculated from the top of the page frame. You cannot set this value manually for anchored frames. |
NextGraphicInDoc |
FMObject |
Denotes the next graphic object in the document. |
NextGraphicInFrame |
FMObject |
Denotes the next graphic object in the frame. |
NextGraphicInGroup |
FMObject |
Denotes the next graphic object in the group. |
NextSelectedGraphicInDoc |
FMObject |
Denotes the next selected graphic object in the document. |
ObjectAttributes |
A list of strings. Each string expresses an attribute that is specified for an anchored frame in the Object Properties > Object Attributes dialog box. Each string is in the form of string_text.You can use the backslash to escape characters such as \n, \r, or \t for newline, carriage return, and tab, respectively. For a backslash character in the string text, type \\. |
|
Overprint |
int |
Specifies the overprint settings for the object. The possible values are: •Constants.FV_KNOCKOUT (0x00) •Constants.FV_OVERPRINT (0x01) •Constants.FV_FROMCOLOR (0x02) |
Pen |
int |
Specifies the pen pattern (numbers between 0 and 7). Constants are provided for pen patterns 0, 7 and 15, as follows: •Constants.FV_FILL_BLACK (0) •Constants. FV_FILL_WHITE (7) •Constants.FV_FILL_CLEAR (15) |
PrevGraphicInFrame |
FMObject |
Denotes the previous graphic object in the frame. |
PrevGraphicInGroup |
FMObject |
Denotes the previous graphic object in the group. |
Runaround |
int |
Specifies whether text can flow around the object and, if so, whether the text follows the contour of the object or a box shape surrounding the object. The possible values are: •Constants.FV_TR_NONE (0x01) •Constants.FV_TR_CONTOUR (0x02) •Constants.FV_TR_BBOX (0x03) |
RunaroundGap |
int |
Denotes the width of the runaround gap, if the object is a runaround object. |
TailArrow |
int |
Set to 1 if the arrowhead is enabled at the begining of the line; Set to 0 otherwise. |
TintPercent |
int |
Specifies the tint percentage. |
Unique |
int |
Indicates the graphic object's internal unique number. |
Width |
int |
Denotes the width of the object. The permissible range is from 0.125 points to 3600 points. |