3 out of 23 rated this helpful - Rate this topic

CustomAction Element (Custom Action)

Windows SharePoint Services 3

SharePoint 2010

Defines a single custom action for a link or toolbar item.

Copy


<CustomAction
  ContentTypeId = "Text"
  ControlAssembly = "Text"
  ControlClass = "Text"
  ControlSrc = "Text"
  Description = "Text"
  GroupId = "Text"
  Id = "Text"
  ImageUrl = "Text"
  Location = "Text"
  RegistrationId = "Text"
  RegistrationType = "Text"
  RequireSiteAdministrator = "TRUE" | "FALSE"
  Rights = "Text"
  Sequence = "Integer"
  ShowInLists = "TRUE" | "FALSE"
  ShowInReadOnlyContentTypes = "TRUE" | "FALSE"
  ShowInSealedContentTypes = "TRUE" | "FALSE"
  Title = "Text">
</CustomAction>

Attributes

Attribute	Description
ContentTypeId	Optional Text. Specifies the ID of a content type to associate with the custom action.
ControlAssembly	Optional Text. Specifies the assembly of a control that supports the custom action.
ControlClass	Optional Text. Specifies a control class that supports the custom action.
ControlSrc	Optional Text. Specifies the relative URL of the .ascx file that serves as the source for the custom action, for example, `"~/_controltemplates/myCustomAction.ascx"`.
Description	Optional Text. Specifies a longer description for the action that is exposed as a tooltip or sub-description for the action.
GroupId	Optional Text. Identifies an action group that contains the action, for example, `"SiteManagement"`. If contained within a custom action group, the value of the GroupId attribute must equal the group ID of the CustomActionGroup element. See Default Custom Action Locations and IDs for a list of the default custom action group IDs that are used in Windows SharePoint Services.
Id	Optional Text. Specifies a unique identifier for the custom action. The ID may be a GUID, or it may be a unique term, for example, `"HtmlViewer"`. See Default Custom Action Locations and IDs for a list of the default custom action IDs that are used in Windows SharePoint Services.
ImageUrl	Optional Text. Specifies a virtual server relative link to an image that presents an icon for the item.
Location	Optional Text. Specifies the location of this custom action, for example, `"Microsoft.SharePoint.SiteSettings"`. If the custom action is a menu item or toolbar button, then the possible options include EditControlBlock, NewFormToolbar, DisplayFormToolbar, and EditFormToolbar. If contained within a custom action group, the value of the Location attribute must equal the location of the CustomActionGroup element. See Default Custom Action Locations and IDs for a list of the default custom action locations that are used in Windows SharePoint Services.
RegistrationId	Optional Text. Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier (ProgID).
RegistrationType	Optional Text. Specifies the registration attachment for a per-item action. Possible values include: ContentType FileType List ProgId
RequireSiteAdministrator	Optional Boolean. TRUE to specify that the item be displayed only if the user is a site administrator; otherwise, FALSE. Using the RequireSiteAdministrator attribute for the drop-down menu of Windows SharePoint Services commands associated with list items is not supported.
Rights	Optional Text. Specifies a set of rights that the user must have in order for the link to be visible, for example, `"ViewListItems,ManageAlerts"`. If not specified, then the action always appears in the list of actions. To specify multiple rights, separate the values by using commas. The set of rights are grouped logically according to AND logic, which means that a user must have all the specified rights to see an action. For a list of possible values, see Microsoft.SharePoint.SPBasePermissions.
Sequence	Optional Integer. Specifies the ordering priority for actions.
ShowInReadOnlyContentTypes	Optional Boolean. TRUE if the custom action is only displayed for read-only content types on the page for managing content types. The default value is FALSE.
ShowInSealedContentTypes	Optional Boolean. TRUE if the custom action is only displayed for sealed content types on the page for managing content types. The default value is FALSE.
Title	Required Text. Specifies the end user description for this action.

Minimum: 1

Maximum: Unbounded

Remarks

You can use the CustomAction element to add standard ASP.NET controls and user controls (for example, text boxes or option buttons) as custom actions in toolbars. However, you can only add controls instantiating menu items to the drop-down menus of toolbars; you cannot add Web Parts or arbitrary controls.

Example

For an example of how this element is used, see Custom Action Definitions.

Other Resources

Default Custom Action Locations and IDs

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

Unable to add EditFormToolbar action by ContentType registration

I've created 2 custom actions, they are defined as following :

<CustomAction
Id="MyTestActions.MyTestAction1"
RegistrationType="ContentType"
RegistrationId="0x0100af0aa3faf19d41339ad84d787dd93550"
Location="EditFormToolbar"
Title="My Test Action">
<UrlAction Url="javascript:alert('ID={ItemId}&ListID={ListId}');return false;"/>
</CustomAction>

<CustomAction
Id="MyTestActions.MyTestAction2"
RegistrationType="ContentType"
RegistrationId="0x0100af0aa3faf19d41339ad84d787dd93550"
Location="EditControlBlock"
Title="My Test Action">
<UrlAction Url="javascript:alert('ID={ItemId}&ListID={ListId}');return false;"/>
</CustomAction>

The "MyTestAction2" works fine, but the "MyTestAction1" doesn't !! Why?

--------------

Issue fixed : the ContentTypeId (RegistrationId field above) must be in upper case!!
This code works fine :
<CustomAction
Id="MyTestActions.MyTestAction1"
RegistrationType="ContentType"
RegistrationId="0x0100AF0AA3FAF19D41339AD84D787DD93550"
Location="EditFormToolbar"
Title="My Test Action">
<UrlAction Url="javascript:alert('ID={ItemId}&ListID={ListId}');return false;"/>
</CustomAction>

Warning : you also have to write it in upper case while defining the ContentType ; actually, it is recommended that every where you use a ContentTypeId you type it in upper case I think.

Hope it can help!

History

3/17/2010
tdelville

3/23/2010
tdelville2

ContentTypeId attribute Does NOT Exist

Does not exist.

History

8/30/2008
Gutek

4/22/2009
Thomas Lee

Use of ControlClass and ControlSrc in CustomAction

I use this sample to add custom control in Toolbar, it does not show any errors, but dhows only MY ECB ITEM as title.

Is it possible to add user control at this menu.

-------

You cannot bring the parameter in UrlAction Url, you should find other way to pass parameter.

History

3/29/2007
idbi

4/22/2009
Thomas Lee

Context menu for .eml files in document library

I need to provide context menu for .eml files in document library in sharepoint 3.0

Does any one know ? pls guide friends...

Code:

<?xml version="1.0" encoding="utf-8" ?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">

<CustomAction
Id="EMLViewer.ECBItemToolbar"
RegistrationType="List"
RegistrationId="101"
ContentTypeId

Location="EditControlBlock"
Sequence="106"
ImageUrl="/_layouts/images/ICEML.GIF"
Title="EML Viewer">
<UrlAction Url="/_layouts/EMLViewer.aspx?SITEURL={SITEURL}&ItemId={ItemId}&ListId={ListId}"/>
</CustomAction>
</Elements>

History

3/25/2008
PrashanthSpark

4/18/2009
Stanley Roark

Sample custom actions

SharePoint Custom Actions in a list view WebPart
http://blog.thekid.me.uk/archive/2008/04/29/sharepoint-custom-actions-in-a-list-view-webpart.aspx

Sample CustomActions for SharePoint
http://blog.thekid.me.uk/archive/2007/06/23/sample-editcontrolblock-customaction-for-sharepoint.aspx

History

5/19/2008
Vince Rothwell

Out-of-box CustomAction identifiers

John Holliday has publishing a list of the OOB CustomAction identifiers enabling the ability to hide links and menu items throughout the application.

http://johnholliday.net/resources/customactions.html

-Rich

History

5/3/2008
Rich Finn [TW]

Creating Menu Item for a Specific List/Document Library Template

I have a blog post on this subject that talks about implementing a menu item that is specific to a custom list/document that the feature is also creating at http://sharepointinsight.com/blog/Lists/Posts/Post.aspx?ID=33. I hope this will help you. Also if you're having trouble getting the {ListId} token to work (you're getting an error stating that the list does not exist) check out this post which should help as well. http://sharepointinsight.com/blog/Lists/Posts/Post.aspx?ID=32

History

12/17/2007
Michael Bollhoefer_1326429567

ContentTypeId Attribute invalid

The ContentTypeId attribute throws an error when registering a CustomAction element feature via STSADM. Use RegistrationId instead with RegistrationType="ContentType"

<CustomAction 
    Id="MyTestActions.MyTestAction1"
    RegistrationType="ContentType"    
    RegistrationId="0x0100DD47B0D8BB58458A8D894A16BDC2CA210100D4067570A1B9DB4B83806954FF25AF7D"
    Location="EditControlBlock"
    Title="My Test Action">
    <UrlAction Url="/_layouts/TestAction1.aspx?ID={ItemId}&amp;ListID={ListId}"/>
  </CustomAction>

History

9/8/2007
Thomas Prentis