Field Members

Include Protected Members
Include Inherited 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

Top

Properties

	Name	Description
	CanBeDeleted	Gets a value that specifies whether the field can be deleted.
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	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.
	Direction	Gets or sets a value that specifies the reading order of the field.
	EnforceUniqueValues
	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.
	InternalName	Gets a value that specifies the field internal name.
	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 re-created on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	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.
	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.)
	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 value that specifies the display name of the field.
	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.
	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 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	When overridden in a derived class, initializes the extended properties associated with the client object. (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.)
	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.

Top

See Also

Reference

Field Class

Microsoft.SharePoint.Client Namespace