Export (0) Print
Expand All

SPField Members

Windows SharePoint Services 3

Represents a field in a list on a Windows SharePoint Services Web site.

The SPField type exposes the following members.

  NameDescription
Public method SPField(SPFieldCollection, String) Initializes a new instance of the SPField class based on the specified field collection object and field name.
Public method 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

  NameDescription
Public property AggregationFunction Gets or sets the aggregation function for the field.
Public property AllowDeletion Gets or sets a Boolean value that specifies whether the field can be deleted.
Public property AuthoringInfo Gets the descriptive string that is used in pages for editing fields to identify the field and its purpose.
Public property CanBeDeleted Gets a Boolean value that indicates whether the field can be deleted.
Public property CanToggleHidden Gets a Boolean value that indicates whether the column can be hidden through the user interface.
Public property DefaultFormula Gets or sets the default formula for a calculated field.
Public property DefaultValue Gets or sets the default value for a field.
Public property DefaultValueTyped Gets the default value object based on the field type.
Public property Description Gets or sets the description for a field.
Public property Direction Gets or sets the direction of the reading order for the field.
Public property DisplaySize Gets or sets the display size for the field.
Public property FieldReferences Gets a string array that contains the internal names of fields that are referenced in a computed field.
Public property 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.
Public property 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.
Public property FieldTypeDefinition Gets an SPFieldTypeDefinition object that represents the field type definition for the field.
Public property FieldValueType Gets the value type of the field when the field type has its own value type.
Public property Filterable Gets a Boolean value that indicates whether the field can be filtered.
Public property 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.
Public property FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type.
Public property Group Gets or sets the column group to which the field belongs.
Public property Hidden Gets or sets a Boolean value that specifies whether the field is displayed in the list.
Public property Id Gets the GUID of the field.
Public property 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.
Public property Indexed Gets or sets a Boolean value that specifies whether the field is indexed.
Public property InternalName Gets the internal name that is used for the field.
Public property 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.
Public property NoCrawl Gets or sets a Boolean value that specifies whether the field can be crawled by a search engine.
Public property ParentList Gets the parent list that contains the field.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property PrimaryPITarget Gets or sets an alternative document processing instruction in which the column value is stored for documents of the specified content type.
Public property 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.
Public property ReadOnlyField Gets or sets a Boolean value that specifies whether values in the field can be modified.
Public property RelatedField Gets or sets the internal name of a field to which the current field is related.
Public property Reorderable Gets a Boolean value that indicates whether values in the field can be reordered.
Public property Required Gets or sets a Boolean value that determines whether the field requires values.
Public property SchemaXml Gets or sets the schema that defines the field.
Public property Scope Gets the Web site-relative path to the list in which the field collection is used.
Public property Sealed Gets a Boolean value that indicates whether other fields can be derived from the field.
Public property ShowInDisplayForm Gets or sets a Boolean value that specifies whether the field is displayed in the form for displaying list items.
Public property ShowInEditForm Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to edit list items.
Public property ShowInListSettings Gets or sets a Boolean value that specifies whether the field is displayed in the page for customizing list settings.
Public property ShowInNewForm Gets or sets a Boolean value that specifies whether the field is displayed in the form that is used to create list items.
Public property ShowInVersionHistory Gets or sets a Boolean value that specifies whether the field is displayed in the page for viewing list item versions.
Public property ShowInViewForms Gets or sets a Boolean value that specifies whether the field is displayed in pages that are used to view list data.
Public property Sortable Gets a Boolean value that determines whether the field can be sorted.
Public property SourceId Gets the namespace that defines the field or the GUID of the list in which the custom field has been created through the user interface.
Public property StaticName Gets or sets the internal name of the field.
Public property Title Gets or sets the display name for the field.
Public property TranslationXml Document content that has been stored in a multilingual database for display as an XML document.
Public property Type Gets or sets the type of the field.
Public property TypeAsString Gets the type of the field as a string value.
Public property TypeDisplayName Gets the display name of the field type.
Public property TypeShortDescription Gets the description of the field.
Public property UsedInWebContentTypes Gets a Boolean value that indicates whether the field is implemented in any content type that is used in the site collection.
Public property Version Gets the version of the field.
Public property XPath Gets or sets the XPath expression to the field.
Top

  NameDescription
Public method Delete Deletes the field.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetCustomProperty Returns the value of a custom property as an object.
Public method GetFieldValue Converts the specified value into a field type value object when the field type requires a complex data type that is different from the parent field type.
Public method GetFieldValueAsHtml Returns the field value in HTML format in order to render the field value directly on the page.
Public method GetFieldValueAsText Returns the field value as plain text.
Public method GetFieldValueForEdit Returns the field value that is rendered in Edit mode in Edit and New forms.
Public method GetHashCode (Inherited from Object.)
Public method GetProperty Returns the value that is contained by the specified property.
Public method GetType (Inherited from Object.)
Public method GetValidatedString Used for data serialization logic and for field validation logic that is specific to a custom field type to convert the field value object into a validated, serialized string.
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAdded Occurs after a field is added.
Public method OnDeleting Occurs when a field is being deleted.
Public method OnUpdated Occurs after changes are made to a field.
Public method SetCustomProperty Sets a value for a specified property.
Public method ToString Returns the title of the field. (Overrides Object.ToString().)
Public method Update() Updates the database with changes that are made to the field.
Public method 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

Community Additions

ADD
Show:
© 2014 Microsoft