Creating Custom Actions in SharePoint 2010

Thinking SharePoint? Think Jornata.

Creating Custom Actions in
SharePoint 2010
Geoff Varosky
Prepared for
Director, Development & Evangelism
Prepared by
Jornata
Jornata
gvarosky@jornata.com
61-63 Chatham Street
Fourth Floor
Follow me on Twitter @gvaro
Boston, MA 02109
Submitted on April 25, 2012

About Me
• Geoff Varosky
– Jornata
• Director, Development & Evangelism
• BASPUG Co-Founder
• SPS Boston Co-Organizer
– Blog : www.sharepointyankee.com
– Email: gvarosky@jornata.com
– Twitter: @gvaro
– LinkedIn & Facebook


Agenda
• What are Custom Actions?
• Demonstrations
– Using SharePoint Designer
– Importing into Visual Studio
– Finding Custom Actions
– Building & Deployment in Visual Studio
• References
• Q&A


What are Custom Actions?
• Bits of XML
<CustomAction
Id=“MyCustomAction”
Location=“Microsoft.SharePoint.SiteSettings
… />

• Links
<CustomAction …>
<UrlAction Url=“http://www.foo.com” />
</CustomAction>

• JavaScript (optional)
<CustomAction …>
<UrlAction Url=“javascript:DoSomething();” />
</CustomAction>

• Code Behind (optional)
<CustomAction
…
ControlAssembly=“MyCode, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=63316a326e123aec"
ControlClass=“MyCode.Class“ />


• Controls
– Button – Menu
– Checkbox – Menu Section
– Color Picker – MRU Split Button
– Combo Box • Most Recently Used

– Drop Down – Spinner
– Flyout Anchor – Split Button
– Insert Table – Text Box
– Label – Toggle Button


(CustomAction) Anatomy 101
<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">
<URLAction URL=“” />
<CommandUI></CommandUI>
</CustomAction>

• 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: SiteTasks


• 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


• RegistrationId (optional)
– Specifies the registration attachment for a per-
item action
– Example (List Identifier – Task List): 107
• {$ListId:Lists/Tasks;}
• (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

– 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).


• 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


• 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://go.gvaro.net/bHaqaQ


• Can be bound to…
– Lists
• Tasks, Document Libraries, Custom, etc.


– File Types
• By Extension - .docx, .pl, .foo, .bar


– Content Types
• Tasks, Documents, Custom
• All (0x)
– http://go.gvaro.net/bbYxRy

– Programmatic Identifiers
• Tasks List (107)
• Content Types (0x)


Building Custom Actions
• SharePoint Designer 2010
• Visual Studio 2010
• CKS:DEV
– Adds Custom Action Item Templates
– http://cksdev.codeplex.com

• NotePad?


Building Custom Actions
• SharePoint Designer 2010
– Build Custom Actions
• List Item Menu
• List View, Edit, Display Forms
• Visual Studio 2010
– Import from WSP file
– Package
– Add Functionality
– Deploy


DEMOS!
Building Custom Actions in SharePoint Designer 2010
Importing Custom Actions into Visual Studio 2010
Listing All Custom Actions
Using CKS:DEV
Custom Action Groups
Hiding Custom Actions
Maybe more?


Bonus Round!
• Referencing JavaScript Files
– Jan Tielens on EUSP
– http://go.gvaro.net/dvCSS6
– Can Add JavaScript into the HEAD of a page using a
Custom Action
– Location references “/_layouts/” always


References
• Eric Kraus
– Listing all Custom Actions in the Farm with
PowerShell
– http://go.gvaro.net/bD7OHm
• MSDN
– Custom Action Definition Schema
• CommandUI Defintions, Extensions, Handlers
• CustomAction, CustomActionGroup, HideCustomAction
• Default Locations and IDs
– http://go.gvaro.net/9q0QV2


References
• Wictor Wilén
– Creating Custom Ribbon Extensions
– Part 1 - http://go.gvaro.net/aFUwBW
– Part 2 - http://go.gvaro.net/aGlydC
• Using JavaScript + Custom Actions to navigate
Document Libraries
– http://go.gvaro.net/h2w8mN


References
• My Blog
– www.sharepointyankee.com
• Search for “Custom Action”
• Creating Custom Actions with SharePoint Designer
• Default List Type IDs
• Deploying Custom Actions Across All List Types
• Custom Actions in SharePoint 2007
• SPBasePermissions Enumeration (Rights)
• Creating Custom Actions using SPD
• “Delete This Site”
• More…


• Meets 2nd Wednesday/Month
• 6P – 8PM
• Microsoft N.E.R.D. Center
• http://www.bostonsharepointug.org
• Twitter: @BASPUG / #BASPUG


• April 28th
• Waltham, MA
• http://biy.ly/SPSBos
• Twitter: @SPSBoston / #SPSBos


Creating Custom Actions in SharePoint 2010

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Ähnlich wie Creating Custom Actions in SharePoint 2010

Ähnlich wie Creating Custom Actions in SharePoint 2010 (20)

Mehr von Geoff Varosky

Mehr von Geoff Varosky (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Creating Custom Actions in SharePoint 2010