[Integration Kit Contents] [Integration Kit What's New] [Integration Kit Function Index] [More Documentation] [PTC]

Fluent UI

Fluent UI Introduction

sd-fluentui-active-p
sd-fluentui-set-combobox-selected-item
sd-fluentui-get-combobox-selected-item
sd-fluentui-set-edit-text
sd-fluentui-get-edit-text

Ribbon Bar
Status Bar

Function Index Top of Page

SD-FLUENTUI-ACTIVE-P  [function]

(sd-fluentui-active-p)
Description:
Predicate to determine whether or not UI is ribbon based.

Return Value:
t - UI of the current version is ribbon based.
nil - UI of the current version is not ribbon based.

Function Index Top of Page

SD-FLUENTUI-SET-COMBOBOX-SELECTED-ITEM  [function]

(sd-fluentui-set-combobox-selected-item availCmd
                                        selectedButtonId)
Description:
Sets the selected item of an available command with a :range property. All combobox controls which are connected with that command will be updated accordingly.

Parameters:
availCmd {List of three STRINGs}
availCmd has to reference an existing available command. It is specified via a list of "Application" "Group" "Command". Read more about the definition of available commands here.
selectedButtonId {STRING}
Specifies the item to be selected in the range. selectedButtonId has to reference an existing item of the command's :range property.

Return Value:
t - success
nil - failure

Example:
(sd-fluentui-set-combobox-selected-item 
  '("SolidDesigner" "Select" "Preselection") "Part")

Function Index Top of Page

SD-FLUENTUI-GET-COMBOBOX-SELECTED-ITEM  [function]

(sd-fluentui-get-combobox-selected-item availCmd)
Description:
Gets the selected item of an available command with a :range property.

Parameters:
availCmd {List of three STRINGs}
availCmd has to reference an existing available command. It is specified via a list of "Application" "Group" "Command". Read more about the definition of available commands here.

Return Value:
selected button id { STRING } - the button id of the selected range entry

Example:
(sd-fluentui-get-combobox-selected-item '("SolidDesigner" "Select" "Preselection"))
==> "Part"

Function Index Top of Page

SD-FLUENTUI-SET-EDIT-TEXT  [function]

(sd-fluentui-set-edit-text availCmd
                           editText)
Description:
Sets the edit text property of an available command. All edit controls which are connected with that command will be updated accordingly.

Parameters:
availCmd {List of three STRINGs}
availCmd has to reference an existing available command. It is specified via a list of "Application" "Group" "Command". Read more about the definition of available commands here.
editText {STRING}
Specifies the text to be displayed in connected edit controls.

Return Value:
t - success
nil - failure

Example:
(sd-fluentui-set-edit-text 
  '("SolidDesigner" "Part and Assy" "Set Active Part") "/p2")

Function Index Top of Page

SD-FLUENTUI-GET-EDIT-TEXT  [function]

(sd-fluentui-get-edit-text availCmd)
Description:
Inquires the edit text property of an available command. This property is updated when a user enters text in a connected edit control.

Parameters:
availCmd {List of three STRINGs}
availCmd has to reference an existing available command. It is specified via a list of "Application" "Group" "Command". Read more about the definition of available commands here.

Return Value:
Current edit text of the specified command.

Example:
(setq text (sd-fluentui-get-edit-text 
  '("SolidDesigner" "Part and Assy" "Set Active Part")))
[Integration Kit Contents] [Integration Kit What's New] [Integration Kit Function Index] [More Documentation] [PTC]
© 2024 Parametric Technology GmbH
(a subsidiary of PTC Inc.), All Rights Reserved