UserInterface Object

 Top  Previous  Next

Description

A UserInterface object is a container for displaying a custom input dialog using the Show command. See the User Interfaces Guide for more information.

 

Inheritance Hierarchy: Object->UserInterface

 

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

ContinueButtonLabel

The string used to specify the caption that is applied to the "Continue" button on the UserInterface panel. This allows the user to enter their own text (i.e. Next, Thruster-Parms, etc).

Type:   String

Access: Read/Write

DataColumnWidth

The width of the data elements on the UserInterface.

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

LabelColumnWidth

The width of the labels on the UserInterface.

Type:   Variable

Access: Read/Write

NavigationType

Determines how the user will navigate the pages of the UserInterface.

Type:   String

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

Title

Used to specify the title of the UserInterface dialog presented to the operational user on run-time.

Type:   String

Access: Read/Write

 
 

 

Methods

 

Name

Description

AddBooleanChoice

Adds a Boolean Choice element to the UserInterface.

AddLabel

Adds a Label element to the UserInterface.

AddMultiChoice

Adds a Multi-Choice element to the UserInterface.

AddMultiChoiceItem

Adds a Multi-Choice Item to a Multi-Choice Element.

AddPage

Adds a Page to the UserInterface.

AddPasswordEntry

Adds a Password Entry element to the UserInterface.

AddPathBrowser

Adds a Path Browser element to the UserInterface.

AddSeparator

Adds a Separator to the UserInterface.

AddTextEntry

Adds a Text Entry element to the UserInterface.

ClearElements

Removes all of the Elements from the UserInterface.

ClearMultiChoiceItems

Removes all of the items from the specified Multi-Choice Element.

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.

 
 

 

Deprecated Methods

 

Name

Description

AddSeperator

Adds a Separator to the UserInterface.

 

This method has been Deprecated. Please use the correctly-spelled method, UserInterface.AddSeparator.

 
 

 

 

See also

Custom User Interface Guide