Property name |
Data Type |
Description |
---|---|---|
AFrameIsCropped |
bool |
Indicates whether the anchored frame is cropped or not. Possible values are: 0 - (Default) Indicates the frame is not cropped. 1 - Indicates the frame is cropped. |
AFrameIsFloating |
bool |
Indicates whether the anchored frame is set to be floatable or not. Possible values are: 0 - (Default) Indicates the frame is not floatable. 1 - Indicates the frame is floatable. |
Alignment |
number |
Indicates how the anchored frame is aligned. Possible values are: •Constants.FV_ALIGN_LEFT (0) •Constants.FV_ALIGN_CENTER (1) •Constants.FV_ALIGN_RIGHT (2) •Constants.FV_ALIGN_INSIDE (3) •Constants.FV_ALIGN_OUTSIDE (4) |
AnchorType |
number |
Indicates the location where the frame is anchored. Possible values are: •Constants.FV_ANCHOR_INLINE (1) •Constants.FV_ANCHOR_TOP (2) •Constants.FV_ANCHOR_BELOW (3) •Constants.FV_ANCHOR_BOTTOM (4) •Constants.FV_ANCHOR_SUBCOL_LEFT (5) •Constants.FV_ANCHOR_SUBCOL_RIGHT (6) •Constants.FV_ANCHOR_SUBCOL_NEAREST (7) •Constants.FV_ANCHOR_SUBCOL_FARTHEST (8) •Constants.FV_ANCHOR_SUBCOL_INSIDE (9) •Constants.FV_ANCHOR_SUBCOL_OUTSIDE (10) •Constants.FV_ANCHOR_TEXTFRAME_LEFT (11) •Constants.FV_ANCHOR_TEXTFRAME_RIGHT (12) •Constants.FV_ANCHOR_TEXTFRAME_NEAREST (13) •Constants.FV_ANCHOR_TEXTFRAME_FARTHEST (14) •Constants.FV_ANCHOR_TEXTFRAME_INSIDE (15) •Constants.FV_ANCHOR_TEXTFRAME_OUTSIDE (16) •Constants.FV_ANCHOR_RUN_INTO_PARAGRAPH (17) |
BaselineOffset |
number |
Baseline Offset |
Element |
If the anchored frame is in a structured flow in a FrameMaker document, Element indicates the element containing the anchored frame. |
|
InTextFrame |
Indicates the text frame in which the anchored frame is placed. |
|
InTextObj |
FMObject |
Indicates the column or text frame in which the anchored frame is placed. |
NextAFrame |
Contains the next anchored frame in the text frame. |
|
PrevAFrame |
Contains the previous anchored frame in the text frame. |
|
SideOffset |
number |
Denotes the near side offset. |
TextLoc |
Contains the location of the anchor symbol. |
|
FirstGraphicInFrame |
FMObject |
Contains the first object in the anchored frame. |
LastGraphicInFrame |
FMObject |
Contains the last object in the anchored frame. |
Angle |
number |
Indicates the angle of rotation of the graphic object. |
ArrowBaseAngle |
number |
Denotes the arrowhead base angle in degrees. |
ArrowLength |
number |
Denotes the arrowhead length (always rounded down to the nearest 1/256 point). |
ArrowScaleFactor |
number |
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 |
number |
Set to 1 if arrowhead is scaled as the line width changes. Set to 0, otherwise. |
ArrowTipAngle |
number |
Denotes the arrowhead tip angle in degrees. |
ArrowType |
number |
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 |
number |
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 |
number |
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 |
number |
Set to 1 if the graphic object cannot be selected. Set to 0, otherwise. |
GraphicIsSelected |
number |
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 |
number |
Set to 1 if the line has an arrow head. Set to 0, otherwise. |
Height |
number |
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 |
number |
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 |
number |
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 |
number |
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 |
number |
Specifies the overprint settings for the object. The possible values are: •Constants.FV_KNOCKOUT (0x00) •Constants.FV_OVERPRINT (0x01) •Constants.FV_FROMCOLOR (0x02) |
Pen |
number |
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 |
number |
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 |
number |
Denotes the width of the runaround gap, if the object is a runaround object. |
TailArrow |
number |
Set to 1 if the arrowhead is enabled at the begining of the line; Set to 0 otherwise. |
TintPercent |
number |
Specifies the tint percentage. |
Unique |
number |
Indicates the graphic object's internal unique number. |
Width |
number |
Denotes the width of the object. The permissible range is from 0.125 points to 3600 points. |
FirstGraphicInFrame |
FMObject |
Contains the first object in the anchored frame. |
LastGraphicInFrame |
FMObject |
Contains the last object in the anchored frame. |