Creating Custom Actions within SharePoint

Creating Custom Actionswithin SharePointGeoff Varosky

About Me
Geoff Varosky MCP, MCTS
Senior Solutions Developer for Grace-Hunt, LLC.
Blog: http://www.geoffvarosky.com
Email: gvarosky@grace-hunt.com
Twitter: @gvaro

About Grace-Hunt
Founded in 2004
Based in Hudson, MA
Presence in North East, Mid Atlantic, and South East Regions
Microsoft Gold Partner
Specializing in SharePoint and Dynamics (CRM, SL, GP, NAV) Consulting, Implementation, and Integration
Web: http://www.grace-hunt.com
Twitter: @gvaro
Blog: www.geoffvarosky.com
Company: www.grace-hunt.com

Agenda
What are Custom Actions?
Demonstrations
Creating a Simple Custom Action
Anatomy of a Custom Action
Creating a Slightly More Complex Custom Action
Hiding Custom Actions
Custom Action Groups
References
Q&A
Twitter: @gvaro

Examples
Toolbars
Twitter: @gvaro

Examples
Site Actions Menu
Twitter: @gvaro

Examples
Site Settings
Twitter: @gvaro

Examples
Site Settings (Custom Action Group)
Twitter: @gvaro

Examples
Edit Control Block (ECB)
Twitter: @gvaro

Examples
Central Administration Pages
Twitter: @gvaro

Just What Are Custom Actions?
Per Microsoft –
“A custom action represents a link, toolbar button, menu item, or any control that can be added to a toolbar or menu that a user sees. Custom actions can be bound to list type, content type, file type, or programmatic identifier (ProgID).”
Source: http://snipurl.com/d8y70
Twitter: @gvaro

What does that mean?
Bits of XML
Deployed via Features
Create a Link within SharePoint
Specific Location
JavaScript, AJAX, URLs, etc.
Twitter: @gvaro

Custom Actions can be bound to List Types
A Custom Action can be bound to a Document Library, but, may not be bound to a Task List
Example: Check In/Check Out
Twitter: @gvaro

Custom Actions can be bound to File Types
Example: ‘Edit in Microsoft Word’ bound to Word (.doc, .docx) document types
Twitter: @gvaro

Custom Actions can be bound to Content Types
Example: Folders, Document Content Types, List Content Types, etc.
Programmatic Identifiers
Example: Task List Identifier (107)
http://snipurl.com/ntd5g
Twitter: @gvaro

What Can Custom Actions Do?
But wait, there’s more!
Twitter: @gvaro

But wait, there’s more!
Create links to pages that really should be there…
Example: There is a link to the Site Collection Recycle Bin on the Site Settings page, however, there is no link to the current site Recycle Bin. (Demo #1)
Custom Actions can pass along information to act upon
Example: Add a “Complete Task” action to an Edit Control Block, which calls an ASPX page, taking the parameters of the List ID and Item ID, and updating the task item within a list. (Demo #2)
Twitter: @gvaro

…and more
Custom Actions can also be hidden
Example: You do not want site administrators to be able to delete their sites by using the Delete This Site link on the Site Settings page so, we can remove it by using HideCustomAction (Demo #3)
Create Groupings of Custom Actions by using CustomActionGroup
Example: Create a grouping of your Custom Actions on the Site Settings page for all of your Custom Actions… (Demo #4)
Twitter: @gvaro

What Tools Are Needed?
Notepad
What do I use?
Visual Studio
Andrew Connell’s SharePoint Project Utility for Visual Studio
http://snipurl.com/d8yv9
Requires DevExpress DX Core to be installed (free)
WSPBuilder (CodePlex)
http://snipurl.com/d8yxv
SharePoint Solution Installer (CodePlex)
http://snipurl.com/nt6ux
Twitter: @gvaro

Demo
Creating a Simple
Custom Action
View Demo: http://www.vimeo.com/9728285
Twitter: @gvaro

Feature Definition (feature.xml)
Twitter: @gvaro

Scope
Web
A “sub-site”
Only activates the feature on the specific web
Site
Site Collection
Applies to all webs within the site collection
Web Application
Applies to all site collections and webs within a web application
Farm
Applies to all web applications, site collections, etc.....
Twitter: @gvaro

Element Manifest (manifest.xml)
Twitter: @gvaro

<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>
Twitter: @gvaro

Id (optional)
Specifies a unique identifier for custom action
May be a GUID or a unique term
Example:DeleteWeb
GroupID(optional)
Identifies the unique group that this element is contained in
Example:SiteAdministration
Twitter: @gvaro

Location (optional)
Specifies the location for this custom action
Example:Microsoft.SharePoint.SiteSettings
RegistrationType(optional)
Specifies the list, item content type, file type, or programmatic identifier that this action is associated with
Example: List
Twitter: @gvaro

RegistrationId(optional)
Specifies the registration attachment for a per-item action
Example (List Identifier – Task List): 107 (http://snipurl.com/ntd5g)
Title (required)
Specifies the name of your action
Example: DeleteWeb
Description (optional)
Longer description for action which is shown as a tooltip or sub-description (where applicable) for the action
Twitter: @gvaro

Sequence (optional)
The order in which your action will appear.
If not specified, displayed in the order it is read by SharePoint by Feature and by order in element listing (XML).
Twitter: @gvaro

Permissions
RequireSiteAdministrator (optional)
Boolean (True or False)
Cannot be used on ECB menu list items
Rights
Specify rights needed for this Custom Action to be visible
Example: “ApproveItems,DeleteListItems”
Possible Values http://snipurl.com/ntcz5
Twitter: @gvaro

UrlAction Tokens
~site
References the current SPWeb context
~sitecollection
References the current SPSite context
{ItemId}
GUID of the item action is called from
{ItemUrl}
URL of the item the action is called from
Twitter: @gvaro

UrlAction Tokens
{ListId}
GUID representation of the list
{SiteUrl}
References the URL of the SPWeb context the action is called from
{RecurrenceId}
Unsupported in context menus (http://snipurl.com/ntcjc)
Source URL
This token is not available, but there is a way to get it via JavaScript, which we will see in Demo #2
http://snipurl.com/d8zb6
Twitter: @gvaro

Demo
Creating a Slightly More Complex Custom Action
Twitter: @gvaro

Demo
Hiding Custom Actions
Twitter: @gvaro

Demo
Custom Action Groups
Twitter: @gvaro

Resources
My Blog
http://www.geoffvarosky.com
Click on SharePoint Saturday category on left side of page
GraceHunt.SharePointCodePlex Projects
http://codeplex.com/GraceHunt
John Holliday’s Custom Action Resources
Hiding Custom Actions, and a Utility to get all custom action identifiers http://snipurl.com/d8zea
Twitter: @gvaro

Resources
MSDN
Custom Action Definitions
http://snipurl.com/d8zi7
Default Custom Action Locations and IDs
http://snipurl.com/d8zka
How to: Add Custom Actions to the User Interface
http://snipurl.com/d8zq2
CustomAction Element
http://snipurl.com/d9jd4
CustomActionGroup Element
http://snipurl.com/d9jfx
HideCustomAction Element
http://snipurl.com/d9jhs
Twitter: @gvaro

Resources
Custom Actions in SharePoint 2010
Adding Custom Button to the SharePoint 2010 Ribbon
http://snipurl.com/tz3vq by Jonathon Frost @ MSDN
Adding Custom Actions to the List Item Menu in SharePoint 2010 Using SharePoint Designer 2010 http://snipurl.com/tr0t3 by Geoff Varosky
How to Add a Tab to the Ribbon in SharePoint Foundation http://snipurl.com/tz3wi by Andrew May @ SP Dev Doc Team
Twitter: @gvaro

Q&A
Twitter: @gvaro

About Me
Geoff Varosky MCP, MCTS
Senior Solutions Developer for Grace-Hunt, LLC.
Company: http://www.grace-hunt.com
Blog: http://www.geoffvarosky.com
Twitter: @gvaro

Creating Custom Actions within SharePoint

by Geoff Varosky on Apr 12, 2010

Accessibility

Categories

Upload Details

Usage Rights

2 Embeds 20

Statistics

Creating Custom Actions within SharePoint Presentation Transcript

http://www.slideshare.net	19
http://static.slidesharecdn.com	1