Defining Custom Columns in SharePoint – Field Types and Options

26 April, 2009 3 Comments

A common task for SharePoint developers is defining Site Columns (or Fields) as part of a Feature. When defining a field, you need to assign the field a type. I have created this reference table below to help you map between the the “Create Site Column” SharePoint page to the attributes you would set when defining the field as part of a feature.

Defining Columns using the UI

Create Site Column Page

Defining Columns in an Elements file as part of a feature

  1: <Field ID="{CCF0A1BF-4823-459c-9773-73890231E070}"

  2:        Name="ActiveProject"

  3:        DisplayName="Is Project Active"

  4:        Group="Litware"

  5:        Type="Boolean"/>

Type (as shown on the Create Column page)	Field Type	Notes	MSDN Links
Single line of text	Type=”Text”		Microsoft.Sharepoint.SPFieldText
Multiple lines of text	Type=”Note”	In the Create Column page, can pick the type of text to allow. To enable the different sub-types, you need to set a couple of other attributes on the field element. Plain Text RichText=”FALSE” (default value) Rich Text RichText=”TRUE” RichTextMode=”Compatible” (default value) Enhanced Text RichText=”TRUE” RichTextMode=”FullHtml” In addition, you can also set the number of lines to display using the NumLine attribute. Further Information on MSDN:	Microsoft.Sharepoint.SPFieldMultiLineText
Choice (menu to choose from)	Single Choice Type=”Choice” Multi-Choice Type=”MultiChoice"	Pick the display format for the Choice and Multi-Choice types, respectively: Drop-Down Menu or Combo Box Format=”Dropdowns” Radio Buttons or Check Boxes Format=”RadioButtons” Define the options a user can pick from using the Choices element. Below is a skeleton to explain this. <Field Name=”MyOptions” Type=……> <CHOICES> <CHOICE>Option 1</CHOICE> <CHOICE>Option 2</CHOICE> </CHOICES> </Field> If you would like to give the user an option to add their own value, set the attribute FillInChoice=”TRUE”.	Microsoft.Sharepoint.SPFieldChoice Microsoft.Sharepoint.SPFieldMultiChoice
Number	Type=”Integer”	This field type also lets you define: Minimum Value (0 for example) Min=”0” Maximum Value (100 for example) Max=”100” Decimal Places (Default is Automatic, example 2 decimal places) Decimals=”2” Show as Percentage (Default is False) Percentage=”FALSE”	Microsoft.SharePoint.SPFieldNumber
Currency	Type=”Currency”	This field type also lets you define: Minimum Value (0 for example) Min=”0” Maximum Value (100 for example) Max=”100” Decimal Places (Default is Automatic, example 2 decimal places) Decimals=”2” Currency Format This sets the display format of the currency. LCID=”3081” 3081 sets the format English – Australian. For a complete list of Locales, see the MSDN link in the next column.	Microsoft.Sharepoint.SPFieldCurrency Locale IDs
Date and Time	Type=”DateTime”	This field also lets you define: Date and Time Format Show the date only: Format=”DateOnly” Show the date and time: Format=”DateTime”	Microsoft.Sharepoint.SPFieldDateTime
Yes/No	Type=”Boolean”	When setting the default value, you need to use the binary values: No/False = 0 Yes/True = 1	Microsoft.Sharepoint.SPFieldBoolean
Person or Group	Single User or Group Type=”User” Multiple Users or Groups Type=”MultiUser”	This field also lets you define: Allow multiple selections Set the Type to MultUser and the attribute Mult=”TRUE” Allow selection of People Only UserSelectionMode=”PeopleOnly” People and Groups UserSelectionMode=”PeopleAndGroups” Choose from If you want to limit the option list to a SharePoint Group, use the UserSelectionScope attribute. Set it to the ID of the SharePoint group (Integer value). For example, UserSelectionScope=”3”. Show field Set the name of the field from the User’s profile properties that you want to display. For example, show the user’s name property: ShowField=”Name” If you would also like to show presence (Office Communicator integration required): Presence=”TRUE”	Microsoft.Sharepoint.SPFieldUser
Hyperlink or Picture	Type=”URL”	You can display the URL as a Hyperlink or Picture. Use the Format attribute to pick which one: Hyperlink Format=”Hyperlink” Picture Format=”Image”	Microsoft.Sharepoint.SPFieldUrl

Hope this helps you when defining site columns/field.

And one last thing, please remember to also define a group to your organise your fields using the Group=”My Columns” attribute!

Other references:

- Ton Stegeman’s Blog

Like this:

One blogger likes this post.

Filed under SharePoint Development

3 Responses to Defining Custom Columns in SharePoint – Field Types and Options

Vivian says:

4 August, 2009 at 8:25 am

Hi Peter, Do you know of any way that you can include the column\’s selected values in the (detail) page so that the page properties & items displayed on a page are in synch?Thanks in advance & best regards, Vivian

Reply
Pingback: Defining Custom Columns in SharePoint « Sérgio's SharePoint Corner
naimishpandya says:

29 October, 2011 at 2:33 am

Hi Peter,

Thank you so much, Thank you very much for your this post.

I was searching from last few weeks about what could be the data type of “Person Or Group” in Visual Studio code, ONLY from your blog, I found that it is “User”

That helped a lot!!

Thank you so much once again!!

Thanks & Regards,
Naimish Pandya
http://naimishpandya.wordpress.com/

Reply

Peter Sullivan – SharePoint, TFS and .NET Learnings

Defining Custom Columns in SharePoint – Field Types and Options

Like this:

3 Responses to Defining Custom Columns in SharePoint – Field Types and Options

Leave a Reply Cancel reply

Categories

Blogroll

Reference

Tags

Follow “Peter Sullivan - SharePoint, TFS and .NET Learnings”