QueryActionEnabled Method

In This Topic

Queries the object for the enabled status of one or more commands.

Syntax

Visual Basic
C#

'Declaration
 
Public Function QueryActionEnabled( _
   ByVal action As DesignerAction _
) As Boolean

public bool QueryActionEnabled( 
   DesignerAction action
)

Parameters

action: DesignerAction Types

Return Value

True, if the enabled status is true, else False.

Remarks

This method is utilized to determine the availability of actions within the designer, such as commands related to editing, formatting, or other design-time operations. An action being enabled implies that it is available for use under the current state of the designer.

Example

This example shows how to determine if the "Convert to Master" action is enabled for the current report loaded in the designer.

/// <summary>
/// SetStatus - Updates a toolbutton's status, based on a designer action
/// </summary>
/// <param name="action">DesignerAction to take in string format</param>
/// <param name="toolButton">ToolButton to update</param>
private void SetStatus(string action,System.Windows.Forms.ToolBarButton toolButton)
{
    DesignerAction daAction = GetActionFromString(action);
    //Do the following if the DesignerAction isn't a FileOpen
    if(daAction != DesignerAction.FileOpen)
    {
        //Set toolButton attributes based on the Designer Action
        toolButton.Enabled = this.ardMain.QueryActionEnabled(daAction);
        toolButton.Pushed = this.ardMain.QueryActionChecked(daAction);
    }    
}

Visual Basic

'SetStatus - Updates a toolbutton's status, based on a designer action
'Parameter Name: action - DesignerAction to take in string format
'Parameter Name: toolButton - ToolButton to update
Private Sub SetStatus(ByVal action As String, ByVal toolButton As System.Windows.Forms.ToolBarButton)
    Dim daAction As DesignerAction = GetActionFromString(action)
    'Do the following if the DesignerAction isn't a FileOpen
    If daAction <> DesignerAction.FileOpen Then
        'Set toolButton attributes based on the Designer Action
        toolButton.Enabled = Me.ardMain.QueryActionEnabled(daAction)
        toolButton.Pushed = Me.ardMain.QueryActionChecked(daAction)
    End If
End Sub 'SetStatus

Reference

Designer Class
Designer Members
GrapeCity.ActiveReports.Design.Win~GrapeCity.ActiveReports.Design.DesignerAction