Field members

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

The Field type exposes the following members.

Constructors

	Name	Description
	Field	Initializes a new instance of the Field object.

Top

Properties

	Name	Description
	AutoIndexed
	CanBeDeleted	Gets a value that specifies whether the field can be deleted.
	ClientSideComponentId
	ClientSideComponentProperties
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	CustomFormatter
	DefaultFormula
	DefaultValue	Gets or sets a value that specifies the default value for the field.
	Description	Gets or sets a value that specifies the description of the field.
	DescriptionResource
	Direction	Gets or sets a value that specifies the reading order of the field.
	EnforceUniqueValues	Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false.
	EntityPropertyName	Gets the name of the entity property for the list item entity that uses this field.
	FieldTypeKind	Gets or sets a value that specifies the type of the field.
	Filterable	Gets a value that specifies whether list items in the list can be filtered by the field value.
	FromBaseType	Gets a Boolean value that indicates whether the field derives from a base field type.
	Group	Gets or sets a value that specifies the field group.
	Hidden	Gets or sets a value that specifies whether the field is hidden in list views and list forms.
	Id	Gets a value that specifies the field identifier.
	Indexed	Gets or sets a Boolean value that specifies whether the field is indexed.
	InternalName	Gets a value that specifies the field internal name.
	JSLink	When implemented in a derived class, gets or sets the name of an external JavaScript file that contains any client rendering logic for fields of the derived type.
	NoCrawl
	ObjectData	Gets the object data for the current client object. (Inherited from ClientObject.)
	ObjectVersion	Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Path	Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	PinnedToFiltersPane
	ReadOnlyField	Gets or sets a value that specifies whether the value of the field is read-only.
	Required	Gets or sets a value that specifies whether the field requires a value.
	SchemaXml	Gets or sets a value that specifies the XML schema that defines the field.
	SchemaXmlWithResourceTokens	Gets the schema that defines the field and includes resource tokens.
	Scope	Gets a value that specifies the server-relative URL of the list or the site that the field belongs to.
	Sealed	Gets a value that specifies whether properties on the field cannot be changed and whether the field cannot be deleted.
	ServerObjectIsNull	Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
	ShowInFiltersPane
	Sortable	Gets a value that specifies whether list items in the list can be sorted by the field value.
	StaticName	Gets or sets a value that specifies a customizable identifier of the field.
	Tag	Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
	Title	Gets or sets a value that specifies the display name of the field.
	TitleResource
	TypeAsString	Gets or sets a value that specifies the type of the field.
	TypeDisplayName	Gets a value that specifies the display name for the type of the field.
	TypedObject	Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
	TypeShortDescription	Gets a value that specifies the description for the type of the field.
	ValidationFormula	Gets or sets a value that specifies the data validation criteria for the value of the field.
	ValidationMessage	Gets or sets a value that specifies the error message returned when data validation fails for the field.

Top

Methods

	Name	Description
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
	CustomFromJson	Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	DeleteObject	Deletes the field from the list, from the site, or from the content types within the list.
	FromJson	Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitNonPropertyFieldFromJson	Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitOnePropertyFromJson	(Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
	IsObjectPropertyInstantiated	Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
	Retrieve()	Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Retrieve([])	Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	SetShowInDisplayForm	Sets the value of the ShowInDisplayForm property for this field.
	SetShowInEditForm	Sets the value of ShowInEditForm property for this field.
	SetShowInNewForm	Sets the value of ShowInNewForm property for this field.
	ToString	(Inherited from Object.)
	Update	Commits changed properties of the field.
	UpdateAndPushChanges	Commits changed properties of the field and propagates changes to all lists that use the field.
	UpdateClientObjectPropertyType	Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
	ValidateSetValue	Validates and sets the value of the field for the list item based on an implementation-specific transformation of the value.

Top

See also

Reference

Field class

Microsoft.SharePoint.Client namespace