asposediagram.api

asposediagram.api

Class Act

Defines custom command names that appear on an object's shortcut menu and specifies the actions that the commands take.

Constructor Summary
Act()
Constructor.
 
Property Getters/Setters Summary
methodgetAction()
Contains the formula to execute when a user clicks the command name defined in the corresponding Menu element.
methodgetBeginGroup()
Indicates whether a separator is inserted into the menu above this action.
methodgetButtonFace()
It identifies the icon that appears next to an item on a shortcut menu.
methodgetChecked()
Determines whether a check mark is displayed beside the command name on a shape's shortcut menu.
methodgetDel()
method
setDel(value)
           A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
methodgetDisabled()
Disabled element determines whether the command name is displayed on the shortcut menu.
methodgetFlyoutChild()
Determines whether the action row is a child flyout menu of the last row above it that is not a flyout child.
methodgetID()
method
setID(value)
           The unique ID of the element within its parent element.
methodgetInvisible()
Invisible element indicates whether the action is visible on the smart tag or shortcut menu.
methodgetIX()
method
setIX(value)
           The zero-based index of the element within its parent element.
methodgetMenu()
Specifies the name of the command that appears on the shortcut menu for a shape or page.
methodgetName()
method
setName(value)
           The name of the element.
methodgetNameU()
method
setNameU(value)
           The universal name of the element.
methodgetReadOnly()
Determines whether the action on a smart tag or shortcut menu is read-only.
methodgetSortKey()
It specifies a number that determines the order of actions that appear on a shortcut or smart tag menu.
methodgetTagName()
It contains the name of the smart tag that the action is associated with.
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

    • Constructor Detail

      • Act

        Act()
        Constructor.

    • Property Getters/Setters Detail

      • getName/setName : String 

        String getName() / setName(value)
        The name of the element.

      • getNameU/setNameU : String 

        String getNameU() / setNameU(value)
        The universal name of the element.

      • getID/setID : int 

        int getID() / setID(value)
        The unique ID of the element within its parent element.

      • getIX/setIX : int 

        int getIX() / setIX(value)
        The zero-based index of the element within its parent element.

      • getDel/setDel : int 

        int getDel() / setDel(value)
        A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.

      • getMenu : Str2Value 

        Str2Value getMenu()
        Specifies the name of the command that appears on the shortcut menu for a shape or page.

      • getAction : DoubleValue 

        DoubleValue getAction()
        Contains the formula to execute when a user clicks the command name defined in the corresponding Menu element.

      • getChecked : BoolValue 

        BoolValue getChecked()
        Determines whether a check mark is displayed beside the command name on a shape's shortcut menu.

      • getDisabled : BoolValue 

        BoolValue getDisabled()
        Disabled element determines whether the command name is displayed on the shortcut menu.

      • getReadOnly : BoolValue 

        BoolValue getReadOnly()
        Determines whether the action on a smart tag or shortcut menu is read-only.

      • getInvisible : BoolValue 

        BoolValue getInvisible()
        Invisible element indicates whether the action is visible on the smart tag or shortcut menu.

      • getBeginGroup : BoolValue 

        BoolValue getBeginGroup()
        Indicates whether a separator is inserted into the menu above this action.

      • getFlyoutChild : BoolValue 

        BoolValue getFlyoutChild()
        Determines whether the action row is a child flyout menu of the last row above it that is not a flyout child.

      • getTagName : Str2Value 

        Str2Value getTagName()
        It contains the name of the smart tag that the action is associated with.

      • getButtonFace : Str2Value 

        Str2Value getButtonFace()
        It identifies the icon that appears next to an item on a shortcut menu.

      • getSortKey : Str2Value 

        Str2Value getSortKey()
        It specifies a number that determines the order of actions that appear on a shortcut or smart tag menu.

    • Method Detail

      • deepClone

        Object deepClone()
        Creates deep copy of this instance.
        Returns: