Export (0) Print
Expand All

Field members

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

The Field type exposes the following members.

  Name Description
Public method Field Initializes a new instance of the Field object.
Top

  Name Description
Public property CanBeDeleted Gets a value that specifies whether the field can be deleted.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property DefaultValue Gets or sets a value that specifies the default value for the field.
Public property Description Gets or sets a value that specifies the description of the field.
Public property Direction Gets or sets a value that specifies the reading order of the field.
Public property EnforceUniqueValues Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false.
Public property EntityPropertyName Gets the name of the entity property for the list item entity that uses this field.
Public property FieldTypeKind Gets or sets a value that specifies the type of the field.
Public property Filterable Gets a value that specifies whether list items in the list can be filtered by the field value.
Public property FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type.
Public property Group Gets or sets a value that specifies the field group.
Public property Hidden Gets or sets a value that specifies whether the field is hidden in list views and list forms.
Public property Id Gets a value that specifies the field identifier.
Public property Indexed Gets or sets a Boolean value that specifies whether the field is indexed.
Public property InternalName Gets a value that specifies the field internal name.
Public property 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.
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property 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.)
Public property 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.)
Public property ReadOnlyField Gets or sets a value that specifies whether the value of the field is read-only.
Public property Required Gets or sets a value that specifies whether the field requires a value.
Public property SchemaXml Gets or sets a value that specifies the XML schema that defines the field.
Public property SchemaXmlWithResourceTokens Gets the schema that defines the field and includes resource tokens.
Public property Scope Gets a value that specifies the server-relative URL of the list or the site that the field belongs to.
Public property Sealed Gets a value that specifies whether properties on the field cannot be changed and whether the field cannot be deleted.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property Sortable Gets a value that specifies whether list items in the list can be sorted by the field value.
Public property StaticName Gets or sets a value that specifies a customizable identifier of the field.
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property Title Gets or sets a value that specifies the display name of the field.
Public property TypeAsString Gets or sets a value that specifies the type of the field.
Public property TypeDisplayName Gets a value that specifies the display name for the type of the field.
Public property TypedObject Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
Public property TypeShortDescription Gets a value that specifies the description for the type of the field.
Public property ValidationFormula Gets or sets a value that specifies the data validation criteria for the value of the field.
Public property ValidationMessage Gets or sets a value that specifies the error message returned when data validation fails for the field.
Top

  Name Description
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method 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.)
Public method DeleteObject Deletes the field from the list, from the site, or from the content types within the list.
Public method 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.)
Protected method 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.)
Protected method InitOnePropertyFromJson (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method 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.)
Public method 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.)
Public method SetShowInDisplayForm Sets the value of the ShowInDisplayForm property for this field.
Public method SetShowInEditForm Sets the value of ShowInEditForm property for this field.
Public method SetShowInNewForm Sets the value of ShowInNewForm property for this field.
Public method ToString (Inherited from Object.)
Public method Update Commits changed properties of the field.
Public method UpdateAndPushChanges Commits changed properties of the field and propagates changes to all lists that use the field.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Public method ValidateSetValue Validates and sets the value of the field for the list item based on an implementation-specific transformation of the value.
Top

Community Additions

ADD
Show:
© 2014 Microsoft