SPField Members

Include Protected Members
Include Inherited Members

Represents a field in a list on a SharePoint Foundation Web site.

The SPField type exposes the following members.

Constructors

	Name	Description
	SPField(SPFieldCollection, String)	Initializes a new instance of the SPField class based on the specified field collection object and field name.
	SPField(SPFieldCollection, String, String)	Initializes a new instance of the SPField class based on the specified field collection object, field type, and field name.

Top

Properties

	Name	Description
	AggregationFunction	Gets or sets the aggregation function for the field.
	AllowDeletion	Gets or sets a Boolean value that specifies whether the field can be deleted.
	AuthoringInfo	Gets the descriptive string that is used in pages for editing fields to identify the field and its purpose.
	CanBeDeleted	Gets a Boolean value that indicates whether the field can be deleted.
	CanBeDisplayedInEditForm	A read-only property indicating whether or not the field can be displayed in an edit form.
	CanToggleHidden	Gets a Boolean value that indicates whether the column can be hidden through the user interface.
	CompositeIndexable	Indicates whether and in what capacity the field can participate in a composite index.
	DefaultFormula	Gets or sets the default formula for a calculated field.
	DefaultListField	Gets a value that indicates whether to show the properties form of a file when it is uploaded to a document library.
	DefaultValue	Gets or sets the default value for a field.
	DefaultValueTyped	Gets the default value object based on the field type.
	Description	Gets or sets the description for a field.
	DescriptionResource	Gets an SPUserResource object that represents the translations for the description of the field.
	Direction	Gets or sets the direction of the reading order for the field.
	DisplaySize	Gets or sets the display size for the field.
	EnforceUniqueValues	Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false.
	FieldReferences	Gets a string array that contains the internal names of fields that are referenced in a computed field.
	FieldRenderingControl	Gets the field type control that is used to render the field in Display, Edit, and New forms, as well as in data form Web Parts or pages that use field controls.
	FieldRenderingMobileControl	Gets the mobile field type control that is used to render the field in Display, Edit, and New forms, data form Web Parts, or any pages that use field controls in mobile applications.
	FieldTypeDefinition	Gets an SPFieldTypeDefinition object that represents the field type definition for the field.
	FieldValueType	Gets the value type of the field when the field type has its own value type.
	Filterable	Gets a Boolean value that indicates whether the field can be filtered.
	FilterableNoRecurrence	Gets a Boolean value that indicates whether a filter can be created on a field in a view that does not expand recurring events.
	FromBaseType	Gets a Boolean value that indicates whether the field derives from a base field type.
	Group	Gets or sets the column group to which the field belongs.
	Hidden	Gets or sets a Boolean value that specifies whether the field is displayed in the list.
	Id	Gets the GUID of the field.
	IMEMode	Gets or sets the Input Method Editor (IME) mode bias to use for the field. The IME enables conversion of keystrokes between languages when one writing system has more characters than can be encoded for the given keyboard.
	Indexable	Read-only property indicating whether the field can be indexed or not.
	Indexed	Gets or sets a Boolean value that specifies whether the field is indexed.
	InternalName	Gets the internal name that is used for the field.
	JumpToField	Gets the name of a field that represents the next question to which users are taken in a survey, which is dependent on the answer they give to the current question.
	LinkToItem	Indicates whether the field should show the link to the display form when displayed in an [XsltListView]. This value can only be set if this object’s LinkToItemAllowed is set to Allowed.
	LinkToItemAllowed	Represents whether or not the LinkToItem must be shown, must be hidden, or can be turned on/off via the LinkToItem setting.
	ListItemMenu	Indicates whether the field should show the drop down menu when displayed in an XsltListView.
	ListItemMenuAllowed	Indicates whether or not the ListItemMenu must be shown, must be hidden, or can be turned on or off via the ListItemMenu setting.
	NoCrawl	Gets or sets a value that specifies whether the field can be crawled by a search engine.
	ParentList	Gets the parent list that contains the field.
	PIAttribute	Gets or sets the attribute in the document processing instruction (specified by the PITarget property) that is used as the column value for property promotion and demotion in XML documents.
	PITarget	Gets or sets the document processing instruction in which the column value is stored in documents of the specified content type, which is used for property promotion and demotion in XML documents.
	PreviewValueTyped	Gets a preview value of field data for a design-time view of the field control in Display and Edit modes when there is no list item data associated with the field.
	PrimaryPIAttribute	Gets or sets an alternate attribute in the document processing instruction, specified by the PrimaryPITarget property, that is used as the column value in property promotion and demotion in XML documents.
	PrimaryPITarget	Gets or sets an alternative document processing instruction in which the column value is stored for documents of the specified content type.
	PushChangesToLists	Gets or sets a Boolean value that specifies whether to propagate changes that are made in the field template to lists that implement the field.
	ReadOnlyField	Gets or sets a Boolean value that specifies whether values in the field can be modified.
	RelatedField	Gets or sets the internal name of a field to which the current field is related.
	Reorderable	Gets a Boolean value that indicates whether values in the field can be reordered.
	Required	Gets or sets a Boolean value that determines whether users must enter a value for the field on New and Edit forms.
	SchemaXml	Gets or sets the schema that defines the field.
	SchemaXmlWithResourceTokens	Gets the schema that defines the field and includes resource tokens.
	Scope	Gets the Web site-relative path to the list in which the field collection is used.
	Sealed	Gets a value that indicates whether Microsoft SharePoint Foundation field type (as specified in the Type property) can be the parent of a custom derived field type.
	ShowInDisplayForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form for displaying list items.
	ShowInEditForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to edit list items.
	ShowInListSettings	Gets or sets a Boolean value that specifies whether the field is displayed in the page for customizing list settings.
	ShowInNewForm	Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to create list items.
	ShowInVersionHistory	Gets or sets a Boolean value that specifies whether the field is displayed in the page for viewing list item versions.
	ShowInViewForms	Gets or sets a Boolean value that specifies whether the field is displayed in pages that are used to view list data.
	Sortable	Gets a Boolean value that determines whether the field can be sorted.
	SourceId	Gets either the namespace that defines a built-in field or, if it a custom field, the GUID that identifies the list or Web site where it was created.
	StaticName	Gets or sets a static name for the field.
	Title	Gets or sets the display name for the field.
	TitleResource	Gets the resource object associated with the field’s display name.
	TranslationXml	Document content that has been stored in a multilingual database for display as an XML document.
	Type	Gets or sets the type of the field.
	TypeAsString	Gets the type of the field as a string value.
	TypeDisplayName	Gets the display name of the field type.
	TypeShortDescription	Gets the description of the field.
	UsedInWebContentTypes	Gets a Boolean value that indicates whether the field is implemented in any content type that is used in the site collection.
	ValidationEcmaScript	Gets an ECMAScript function that corresponds to the field’s validation formula.
	ValidationFormula	Indicates the formula referenced by the field and is evaluated when a list item is added or updated.
	ValidationMessage	Gets or sets a message to display to the user if validation fails for this field.
	Version	Gets the version of the field.
	XPath	Gets or sets the XPath expression to the field.

Top

Methods

	Name	Description
	Delete	Deletes the field.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetCustomProperty	Gets the value of custom property with the specified name.
	GetFieldValue	Converts the specified value into a field type value.
	GetFieldValueAsHtml	Gets the field value in HTML format in order to render the field value directly on the page.
	GetFieldValueAsText	Gets the field value as plain text.
	GetFieldValueForEdit	Gets the field value that is rendered in Edit mode in Edit and New forms.
	GetHashCode	(Inherited from Object.)
	GetProperty	Gets the value of the specified property.
	GetType	(Inherited from Object.)
	GetValidatedString	Validates and converts the field value into a serialized form.
	HasValue	Internal function used to verify whether an object is null or not.
	ListsFieldUsedIn	Returns information about the Web sites and lists in which the current field is used.
	MemberwiseClone	(Inherited from Object.)
	OnAdded	Handles the event that occurs after a field is added.
	OnAddingToContentType	Handles the event that occurs when a field is added to a specified content type.
	OnDeleting	Handles the event that occurs when a field is being deleted.
	OnDeletingFromContentType	Handles the event that occurs when a field is deleted from a specified content type.
	OnInitFieldNode	This member is reserved for internal use and is not intended to be used directly from your code.
	OnUpdated	Handles the event that occurs after changes are made to a field.
	ParseAndSetValue	Sets the specified field item to the specified value.
	SetCustomProperty	Sets a value for the specified property.
	ToString	Returns the title of the field. (Overrides Object.ToString().)
	Update()	Updates the database with changes that are made to the field.
	Update(Boolean)	Updates the database with changes that are made to the field and optionally propagates the changes to lists that implement the field.

Top

See Also

Reference

SPField Class

Microsoft.SharePoint Namespace