WindowOverlayEllipseOptions Object

 Top  Previous  Next

Description

The WindowOverlayEllipseOptions object allows the user to configure an Ellipse 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:

 

WindowOverlay1.Shapes[0].EllipseOptions.BorderWidth = 2;

 

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.

 

Inheritance Hierarchy: Object->WindowOverlayEllipseOptions

Parent Object: WindowOverlayShape

 

Available In Editions:

Engineer

Mission

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Properties

 

Name

Description

Attributes

BorderColor

The color to draw the border.

Type:   Variable

Access: Read/Write

BorderOpacity

The opacity of the border.

Type:   Variable

Access: Read/Write

BorderWidth

The width of the border. A value of zero hides the border.

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

FillColor

The fill color of the shape.

Type:   Variable

Access: Read/Write

FillOpacity

The opacity of the shape.

Type:   Variable

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

 
 

 

Methods

 

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.