TaxonomyField members
Represents a taxonomy field.
The TaxonomyField type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
TaxonomyField | Initializes a TaxonomyField object. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AllowMultipleValues | Gets or sets a value that specifies whether the lookup field allows multiple values. (Inherited from FieldLookup.) |
|
AnchorId | Gets or sets the GUID of the anchor Term object for a TaxonomyField object. |
|
AutoIndexed | (Inherited from Field.) |
|
CanBeDeleted | Gets a value that specifies whether the field can be deleted. (Inherited from Field.) |
|
ClientSideComponentId | (Inherited from Field.) |
|
ClientSideComponentProperties | (Inherited from Field.) |
|
Context | Returns the context that is associated with the client object. (Inherited from ClientObject.) |
|
CreateValuesInEditForm | Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. |
|
CustomFormatter | (Inherited from Field.) |
|
DefaultFormula | (Inherited from Field.) |
|
DefaultValue | Gets or sets a value that specifies the default value for the field. (Inherited from Field.) |
|
DependentLookupInternalNames | (Inherited from FieldLookup.) |
|
Description | Gets or sets a value that specifies the description of the field. (Inherited from Field.) |
|
DescriptionResource | (Inherited from Field.) |
|
Direction | Gets or sets a value that specifies the reading order of the field. (Inherited from Field.) |
|
EnforceUniqueValues | Gets or sets a Boolean value that specifies whether to enforce uniqueness in column values. The default is false. (Inherited from Field.) |
|
EntityPropertyName | Gets the name of the entity property for the list item entity that uses this field. (Inherited from Field.) |
|
FieldTypeKind | Gets or sets a value that specifies the type of the field. (Inherited from Field.) |
|
Filterable | Gets a value that specifies whether list items in the list can be filtered by the field value. (Inherited from Field.) |
|
FromBaseType | Gets a Boolean value that indicates whether the field derives from a base field type. (Inherited from Field.) |
|
Group | Gets or sets a value that specifies the field group. (Inherited from Field.) |
|
Hidden | Gets or sets a value that specifies whether the field is hidden in list views and list forms. (Inherited from Field.) |
|
Id | Gets a value that specifies the field identifier. (Inherited from Field.) |
|
Indexed | Gets or sets a Boolean value that specifies whether the field is indexed. (Inherited from Field.) |
|
InternalName | Gets a value that specifies the field internal name. (Inherited from Field.) |
|
IsAnchorValid | Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid. |
|
IsDependentLookup | (Inherited from FieldLookup.) |
|
IsKeyword | Gets or sets a Boolean value that indicates whether the TaxonomyField value points to the Enterprise Keywords TermSet object. |
|
IsPathRendered | Gets or sets a Boolean value that specifies whether the default Label objects of all the parent Term objects of a Term in the TaxonomyField object will be rendered in addition to the default label of that Term. |
|
IsRelationship | Gets or sets a value that specifies whether this lookup field is returned by GetRelatedField() from the list being looked up to. (Inherited from FieldLookup.) |
|
IsTermSetValid | Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId property exists and is available for tagging. |
|
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. (Inherited from Field.) |
|
LookupField | Gets or sets a value that specifies the internal field name of the field used as the lookup values. (Inherited from FieldLookup.) |
|
LookupList | Gets or sets a value that specifies the list identifier of the list that contains the field to use as the lookup values. (Inherited from FieldLookup.) |
|
LookupWebId | Gets or sets a value that specifies the GUID that identifies the site containing the list which contains the field used as the lookup values. (Inherited from FieldLookup.) |
|
NoCrawl | (Inherited from Field.) |
.gif "Protected property") |
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.) |
|
Open | Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. |
|
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 | (Inherited from Field.) |
|
PrimaryFieldId | Gets or sets a value that specifies the primary lookup field identifier if this is a dependent lookup field Otherwise, it is an empty string. (Inherited from FieldLookup.) |
|
ReadOnlyField | Gets or sets a value that specifies whether the value of the field is read-only. (Inherited from Field.) |
|
RelationshipDeleteBehavior | Gets or sets a value that specifies the delete behavior of the lookup field. (Inherited from FieldLookup.) |
|
Required | Gets or sets a value that specifies whether the field requires a value. (Inherited from Field.) |
|
SchemaXml | Gets or sets a value that specifies the XML schema that defines the field. (Inherited from Field.) |
|
SchemaXmlWithResourceTokens | Gets the schema that defines the field and includes resource tokens. (Inherited from Field.) |
|
Scope | Gets a value that specifies the server-relative URL of the list or the site that the field belongs to. (Inherited from Field.) |
|
Sealed | Gets a value that specifies whether properties on the field cannot be changed and whether the field cannot be deleted. (Inherited from Field.) |
|
ServerObjectIsNull | Gets the server object and returns null if the server object is null. (Inherited from ClientObject.) |
|
ShowInFiltersPane | (Inherited from Field.) |
|
Sortable | Gets a value that specifies whether list items in the list can be sorted by the field value. (Inherited from Field.) |
|
SspId | Gets or sets the GUID that identifies the TermStore object, which contains the Enterprise Keywords for the site that the current TaxonomyField belongs to. |
|
StaticName | Gets or sets a value that specifies a customizable identifier of the field. (Inherited from Field.) |
|
Tag | Gets or sets data that is associated with the client object. (Inherited from ClientObject.) |
|
TargetTemplate | Gets or sets the Web-relative URL of the target page that is used to construct the hyperlink on each Term object when the TaxonomyField object is rendered. |
|
TermSetId | Gets or sets the GUID of the TermSet object that contains the Term objects used by the current TaxonomyField object. |
|
TextField | Gets or sets the GUID that identifies the hidden text field in an item. |
|
Title | Gets or sets a value that specifies the display name of the field. (Inherited from Field.) |
|
TitleResource | (Inherited from Field.) |
|
TypeAsString | Gets or sets a value that specifies the type of the field. (Inherited from Field.) |
|
TypeDisplayName | Gets a value that specifies the display name for the type of the field. (Inherited from 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. (Inherited from Field.) |
|
UnlimitedLengthInDocumentLibrary | (Inherited from FieldLookup.) |
|
UserCreated | Gets or sets a Boolean value that specifies whether the TaxonomyField object is linked to a customized TermSet object. |
|
ValidationFormula | Gets or sets a value that specifies the data validation criteria for the value of the field. (Inherited from Field.) |
|
ValidationMessage | Gets or sets a value that specifies the error message returned when data validation fails for the field. (Inherited from Field.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
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. (Inherited from Field.) |
|
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.) |
|
GetFieldValueAsHtml | Returns the field value in HTML format in order to render the field valuedirectly on a page. |
|
GetFieldValueAsTaxonomyFieldValue | Converts the specified string value into a TaxonomyFieldValue object. |
|
GetFieldValueAsTaxonomyFieldValueCollection | Converts the specified string value into a TaxonomyFieldValueCollection object. |
|
GetFieldValueAsText | Returns a plain text representation of the field value. |
|
GetValidatedString | Validates the field value object using logic specific to the TaxonomyField object, and returns a serialized string representation of the validated field value object. |
|
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 FieldLookup.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.) |
|
SetFieldValueByCollection | Sets the value of the corresponding multi-value field in the list item to the properties of the Term objects in the specified collection, in the specified language. |
|
SetFieldValueByTerm | Sets the value of the corresponding field in the list item to the properties of the specified Term in the specified language. |
|
SetFieldValueByTermCollection | Sets the value of the corresponding multi-value field in the list item to the properties of the Term objects in the specified collection, in the specified language. |
|
SetFieldValueByValue | Sets the value of the corresponding field in the list item to the value of the specified TaxonomyFieldValue object. |
|
SetFieldValueByValueCollection | Sets the value of the corresponding multi-valued field in the list item to the value of the specified TaxonomyFieldValueCollection object. |
|
SetShowInDisplayForm | Sets the value of the ShowInDisplayForm property for this field. (Inherited from Field.) |
|
SetShowInEditForm | Sets the value of ShowInEditForm property for this field. (Inherited from Field.) |
|
SetShowInNewForm | Sets the value of ShowInNewForm property for this field. (Inherited from Field.) |
|
ToString | (Inherited from Object.) |
|
Update | Commits changed properties of the field. (Inherited from Field.) |
|
UpdateAndPushChanges | Commits changed properties of the field and propagates changes to all lists that use the field. (Inherited from 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. (Inherited from Field.) |
Top