GetSuggestedCMDIDs Method (CoreModule)

In This Topic

Gets the suggested daml ids for the given tab identified by 'activeTabID'

Syntax

C#
Visual Basic (Declaration)

public override string[] GetSuggestedCMDIDs( 
   string activeTabID
)

Public Overrides NotOverridable Function GetSuggestedCMDIDs( _
   ByVal activeTabID As String _
) As String()

Parameters

activeTabID: The id of the tab to retrieve the command id list for

Return Value

An array of daml ids

Example

Suggested command options in CommandSearch when a tab is activated.

//In the module class..
public override string[] GetSuggestedCMDIDs(string activeTabID)
{
  //Return the static list of daml ids you want to be the (suggested) 
  //defaults relevant to the given tab. It can be none, some, or all of the
  //commands associated with the activeTabID.
  //In this example, there are two tabs. This example arbitrarily
  //identifies just one command on each tab to be a default to show in the
  //command search list (when _that_ particular tab is active)
  switch (activeTabID)
  {
    case "CommandSearch_Example_Tab1":
      return new string[] { "CommandSearch_Example_Button2" };
    case "CommandSearch_Example_Tab2":
      return new string[] { "CommandSearch_Example_Button4" };
  }
  return new string[] { "" };
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

CoreModule Class
CoreModule Members

Send feedback