WindowOverlayTextOptions Object

The WindowOverlayTextOptions object allows the user to configure a Text shape in a WindowOverlay object. This object is not creatable in script, but is always created as a child object of the WindowOverlayShape object, as seen below:

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
AlignmentHorizontal	The horizontal alignment of the text inside the formatting area.	Type: Variable Access: Read/Write
AlignmentVertical	The vertical alignment of the text inside the formatting area.	Type: Variable Access: Read/Write
BackdropBorderColor	The color to draw the backdrop border.	Type: Variable Access: Read/Write
BackdropBorderOpacity	The opacity of the backdrop border.	Type: Variable Access: Read/Write
BackdropBorderWidth	The width of the backdrop border. A value of zero hides the border.	Type: Variable Access: Read/Write
BackdropFillColor	The fill color of the backdrop.	Type: Variable Access: Read/Write
BackdropFillOpacity	The opacity of the backdrop.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
Font	The Font used to render the text	Type: ViewFont Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
ShowBackdrop	Determines whether a text backdrop is shown.	Type: Variable Access: Read/Write
Text	The text to render	Type: String Access: Read/Write
TextColor	The color of the text.	Type: Variable Access: Read/Write
Wrap	Determines whether text is wrapped inside of the formatting area.	Type: Variable Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetBackdropCornerRadius	Allows you to draw a rounded rectangle as the text backdrop by specifying a corner radius.
SetMargin	Sets the spacing between the edges of the text shape and the text formatting area.

WindowOverlayTextOptions Object

Description

Available In Editions:

Timing Precision Mode