SmallImage Property (PlugIn)

In This Topic

Gets or sets the small representation of the command, this may be an image or a xaml element.

Syntax

Visual Basic (Declaration)
C#

Public Property SmallImage As Object

public object SmallImage {get; set;}

Remarks

Many ribbon controls have three size definitions: large, middle, and small. The large representation is a 32x32 image over its caption. Middle is a 16x16 image beside its caption and small is a 16x16 image only. You should always supply both a large and small image as these may automatically swap depending on the available space in the ribbon.

This property will by default return the small image specified in its DAML declaration. Use this property if you need to change the small image at run-time.

Example

<button id="acme_rename" caption="Rename" className="RenameProjectItem" smallImage="/Images/GenericPencil16.png">
  <tooltip heading="Rename">Rename the project item.
    <disabledText>No project loaded.</disabledText>
  </tooltip>
</button>

Customize the disabledText property of a button or tool

{
  //Set the tool's loadOnClick attribute to "false" in the config.daml. 
  //This will allow the tool to be created when Pro launches, so that the disabledText property can display customized text at startup.
  //Remove the "condition" attribute from the tool. Use the OnUpdate method(below) to set the enable\disable state of the tool.
  //Add the OnUpdate method to the tool.
  //Note: since OnUpdate is called very frequently, you should avoid lengthy operations in this method 
  //as this would reduce the responsiveness of the application user interface.
  {
    bool enableState = true; //TODO: Code your enabled state  
    bool criteria = true;  //TODO: Evaluate criteria for disabledText  

    if (enableState)
    {
      Enabled = true;  //tool is enabled  
    }
    else
    {
      Enabled = false;  //tool is disabled  
                        //customize your disabledText here  
      if (criteria)
        DisabledTooltip = "Missing criteria 1";
    }
  }
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

PlugIn Class
PlugIn Members

Send feedback