GetValue

This method returns the value that was set for a specified menu command.

 

JavaScript

 

GetValue(

       CommandID)

 

C#

 

dynamic GetValue(

       int CommandID)

 

C++

 

HRESULT GetValue(

        long  CommandID,

        VARIANT *   pVal )

 

Parameters

CommandID

The ID of the menu command whose value is being returned. Ribbon commands that are not available in the list below cannot be used from this method. The commands are organized according to Ribbon tabs. The command can have one of the following values:

View Tab

Name

CommandID

Returning Value

Terrain Imagery

Terrain Opacity

1060

Can be any long value from 0 to 100

L/L Coordinates

1061

 

Type: Long

Can be either of the following values:

§   0 – Decimal units

§   1 – Deg, min, sec units

§   1 – Deg, decimal min units

Speed

1062

 

Type: Long

Can be one of the following values:

§   0 - KMH

§   1 - MPH

§   2 - Knots

Altitude

1063

 

Type: Long

Can be either of the following values:

§   0 – Meters

§   1 – Feet

Altitude Type

1064

 

Type: Long

Can be either of the following values:

§   0 – AGL Units

§   1 – Absolute Units

Field of View

FOV

1071

Type: Double

Can be one of the following values: 90.0; 71.0; 53.0; 45.0; 35.0; 25.0; 15.0

Layer Edit Tab

Name

CommandID

Parameter

Layer

Layer list box

1069

An array of Unsigned Long that represents the layer IDs

 

Presentation Tab

Name

CommandID

Parameter

Play

Play Algorithm

1120

Type: Long

Can be one of the following values:

§   0 – FlyTo

§   1 - Spline

Play Mode

1121

Type: Long

Can be one of the following values:

§   0 – AutoPlay

§   1 - Standard

Play Speed

1122

Type: Long

Can be one of the following values:

§   0 – Very slow

§   1 - Slow

§   2 – Normal

§   3 – Fast

§   4- Very fast

Movie

Frames

1117

Type: Long

Number of frames

Frame Size

1118

 

Type: Long

Can be one of the following values:

§   0 – Current size

§   1 – 320X200

§   2 – 320X240

§   3 – 384X288

§   4 – 640X480

§   5 – 768X576

§   6 – 720X480

§   7 – 1280X720

§   8 - 1920X1080

Caption Settings

Size

1135

Type: Long

Can be one of the following values:

§   0 – Fixed size

§   1 – Automatically adjust size

Width

1136

Type: Long

Caption box width

Height

1137

Type: Long

Caption box height

Caption Position

1125

Type: Long

Can be one of the following values:

§   0 – Up left

§   1 – Up center

§   2 – Up right

§   3 – Down left

§   4 – Down center

§   5 – Down right

 

Return Value

pVal

The value that was set for a specified menu command.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.