Sample Code to add a custom button to a custom group in CRM 2011

Hi,

Following is the sample code to add a custom button to a custom group for a custom entity (new_test)

The button gets displayed only when the record is created.

We need to define Display Rule for that in Rule Definitions and use that rule within Command Defintion for the Button


<RibbonDiffXml>
  <CustomActions>
   <CustomAction Id="Sample.Form.new_test.CustomTab.CustomAction" Location="Mscrm.Tabs._children" Sequence="40">
    <CommandUIDefinition>
     <Tab Id="Sample.Form.new_test.CustomTab" Command="Sample.Form.new_test.CustomTab" Title="My First Custom Tab" Description="Finally managed to put my first custom tab" Sequence="40">
      <Scaling Id="Sample.Form.new_test.CustomTab.Scaling">
       <MaxSize Id="Sample.Form.new_test.CustomTab.FirstGroup.MaxSize" GroupId="Sample.Form.new_test.CustomTab.FirstGroup" Sequence="10" Size="LargeMedium"/>
      </Scaling>
      <Groups Id="Sample.Form.new_test.CustomTab.Groups">
       <Group Id="Sample.Form.new_test.CustomTab.FirstGroup" Command="Sample.Form.new_test.FirstGroup" Sequence="10" Title="Custom Group" Template="Mscrm.Templates.3.3">
        <Controls Id="Sample.Grid.new_test.CustomTab.FirstGroup.Controls">
         <Button Id="Sample.Form.new_test.CustomTab.FirstGroup.FirstButton" ToolTipTitle="My First Button Tool Tip" ToolTipDescription="My First Button Tool Tip Description" Command="Sample.Form.new_test.FirstButton" Sequence="10" LabelText="First Button" Alt="Alt First Button" TemplateAlias="o1"/>
        </Controls>
       </Group>
      </Groups>
     </Tab>
    </CommandUIDefinition>
   </CustomAction>
  </CustomActions>
  <Templates>
   <RibbonTemplates Id="Mscrm.Templates"/>
  </Templates>
  <CommandDefinitions>
   <CommandDefinition Id="Sample.Form.new_test.CustomTab">
    <EnableRules>
     <EnableRule Id="Mscrm.Enabled "/>
    </EnableRules>
    <DisplayRules>
     </DisplayRules>
    <Actions/>
   </CommandDefinition>
   <CommandDefinition Id="Sample.Form.new_test.FirstGroup">
    <EnableRules>
     <EnableRule Id="Mscrm.Enabled "/>
    </EnableRules>
    <DisplayRules>
     </DisplayRules>
    <Actions/>
   </CommandDefinition>
   <CommandDefinition Id="Sample.Form.new_test.FirstButton">
    <EnableRules>
     <EnableRule Id="Mscrm.Enabled "/>
    </EnableRules>
    <DisplayRules>
     <DisplayRule Id="Sample.new_test.form.FormStateNotNew.DisplayRule">
       </DisplayRule>
    </DisplayRules>
    <Actions>
     </Actions>
   </CommandDefinition>
  </CommandDefinitions>
  <RuleDefinitions>
   <TabDisplayRules>
    <TabDisplayRule TabCommand="Sample.Form.new_test.CustomTab">
     <EntityRule EntityName="new_test" Context="Form" AppliesTo="PrimaryEntity"/>
    </TabDisplayRule>
   </TabDisplayRules>
   <DisplayRules>
    <DisplayRule Id="Sample.new_test.form.FormStateNotNew.DisplayRule">
     <FormStateRule State="Create" InvertResult="true"/>
    </DisplayRule>
   </DisplayRules>
   <EnableRules/>
  </RuleDefinitions>
  <LocLabels/>
 </RibbonDiffXml>

Hope it helps !

2 thoughts on “Sample Code to add a custom button to a custom group in CRM 2011

Share your thoughts

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s