Public interface to define a Field object of SharePoint Online
public interface IField : IDataModel<IField>, IDataModelParent, IDataModelWithContext, ISupportModules<IField>, IDataModelGet<IField>, IDataModelLoad<IField>, IDataModelUpdate, IDataModelDelete, IQueryableDataModelA special property used to add an asterisk to a $select statement
object All { get; }|
System.Object
|
Gets or sets whether to allow display if the user name
bool AllowDisplay { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field.
bool AllowHyperlink { get; set; }|
System.Boolean
|
Gets or sets whether the lookup fields allows multiple values
bool AllowMultipleValues { get; set; }|
System.Boolean
|
Gets or sets the GUID of the anchor Term object for a TaxonomyField
Guid AnchorId { get; set; }|
Guid
|
Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms.
bool AppendOnly { get; set; }|
System.Boolean
|
Gets or sets a Boolean value that specifies whether the field is auto-indexed
bool AutoIndexed { get; set; }|
System.Boolean
|
Specifies whether or not the field can be deleted
bool CanBeDeleted { get; }|
System.Boolean
|
Gets or sets the choices of choice field
string[] Choices { get; set; }|
System.String[]
|
Gets or Sets the client side component Id associated with the field
Guid ClientSideComponentId { get; set; }|
Guid
|
Gets or Sets the properties of the client side component associated with the field
string ClientSideComponentProperties { get; set; }|
System.String
|
Gets or Sets the validation formula
string ClientValidationFormula { get; set; }|
System.String
|
Gets or Sets the client validation message of the field
string ClientValidationMessage { get; set; }|
System.String
|
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.
bool CreateValuesInEditForm { get; set; }|
System.Boolean
|
Gets or Sets the Locale Id of the currency
int CurrencyLocaleId { get; set; }|
System.Int32
|
Gets or Sets custom formatter of the field
string CustomFormatter { get; set; }|
System.String
|
Gets or Sets the Date Format Valid for DateTime field, Calculated field
DateTimeFieldFormatType DateFormat { get; set; }|
DateTimeFieldFormatType
|
Gets or sets the type of calendar to use of a DateTime field
CalendarType DateTimeCalendarType { get; set; }|
CalendarType
|
Gets or sets the default formula for a calculated field
string DefaultFormula { get; set; }|
System.String
|
Gets or Sets the default value of the field
object DefaultValue { get; set; }|
System.Object
|
Gets the dependent lookup internal names of a lookup field
string[] DependentLookupInternalNames { get; }|
System.String[]
|
Gets or Sets the description of the field
string Description { get; set; }|
System.String
|
Specifies the direction of the reading order for the field. A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left or none
string Direction { get; set; }|
System.String
|
Gets or Sets the display format of the field CAUTION: Is an integer value since according to field type, the display format enum may change
int DisplayFormat { get; set; }|
System.Int32
|
Determines whether to display the choice field as radio buttons or as a drop-down list
ChoiceFormatType EditFormat { get; set; }|
ChoiceFormatType
|
Gets or sets whether the lookup should be enabled for computed field
bool EnableLookup { get; set; }|
System.Boolean
|
Gets or Sets whether the field enforces unique values
bool EnforceUniqueValues { get; set; }|
System.Boolean
|
Gets the name of the entity property for the list item entity that uses this field
string EntityPropertyName { get; }|
System.String
|
Gets or Sets the field type kind of the field https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543%28v%3doffice.15%29
FieldType FieldTypeKind { get; }|
FieldType
|
Gets or sets whether choice field can be filled in by user
bool FillInChoice { get; set; }|
System.Boolean
|
Returns whether the field can be filtered
bool Filterable { get; }|
System.Boolean
|
Specifies the formula that is used for calculation in the field
string Formula { get; set; }|
System.String
|
Gets or sets the friendly format type of a DateTime field
DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; }|
DateTimeFieldFriendlyFormatType
|
Gets a Boolean value that indicates whether the field derives from a base field type.
bool FromBaseType { get; }|
System.Boolean
|
Gets or Sets the group of the field
string Group { get; set; }|
System.String
|
Specifies whether the field is displayed in the list
bool Hidden { get; set; }|
System.Boolean
|
Provides the id of the field
Guid Id { get; }|
Guid
|
Gets or Sets whether the field is indexed
bool Indexed { get; set; }|
System.Boolean
|
Describes whether a field is indexed, and whether the data in the index is complete
FieldIndexStatus IndexStatus { get; }|
FieldIndexStatus
|
Specifies the internal name of the field
string InternalName { get; }|
System.String
|
Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid.
bool IsAnchorValid { get; }|
System.Boolean
|
Check whether a lookup field is a dependent lookup field
bool IsDependentLookup { get; }|
System.Boolean
|
Gets or sets a Boolean value that indicates whether the TaxonomyField value points to the Enterprise Keywords TermSet object.
bool IsKeyword { get; set; }|
System.Boolean
|
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.
bool IsPathRendered { get; set; }|
System.Boolean
|
Specifies whether this Lookup field is discoverable from the List being looked up to
bool IsRelationship { get; set; }|
System.Boolean
|
Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId property exists and is available for tagging.
bool IsTermSetValid { get; }|
System.Boolean
|
Gets or sets the name of an external JS file containing any client rendering logic for fields of this type
string JSLink { get; set; }|
System.String
|
Specifies the name of the Field used as the lookup values
string LookupField { get; set; }|
System.String
|
Specifies the id (GUID) of the List that contains the Field to use as the lookup values
string LookupList { get; set; }|
System.String
|
Specifies the id of the Site that contains the List which contains the Field used as the lookup values
Guid LookupWebId { get; set; }|
Guid
|
Gets the mappings of a choice field
string Mappings { get; }|
System.String
|
Gets or sets the maximum value of a number field
double MaximumValue { get; set; }|
System.Double
|
Specifies the maximum number of characters that can be typed in the field
int MaxLength { get; set; }|
System.Int32
|
Gets or sets the minimum value of a number field
double MinimumValue { get; set; }|
System.Double
|
Gets or sets a value that specifies the number of lines of text to display for the field.
int NumberOfLines { get; set; }|
System.Int32
|
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.
bool Open { get; set; }|
System.Boolean
|
Gets or sets the type of a calculated field output
FieldType OutputType { get; set; }|
FieldType
|
Gets or sets whether to display the presence indicator of the user
bool Presence { get; set; }|
System.Boolean
|
Specifies the GUID of the primary lookup field if this is a dependent lookup field. Otherwise, it is empty string
string PrimaryFieldId { get; set; }|
System.String
|
Specifies whether values in the field can be modified
bool ReadOnlyField { get; set; }|
System.Boolean
|
Specifies the Delete Behavior of the Lookup Field
RelationshipDeleteBehaviorType RelationshipDeleteBehavior { get; set; }|
RelationshipDeleteBehaviorType
|
Gets or Sets whether the field is required
bool Required { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether the field supports a subset of rich formatting.
bool RestrictedMode { get; set; }|
System.Boolean
|
Gets or sets a value that specifies whether the field supports rich formatting.
bool RichText { get; set; }|
System.Boolean
|
Specifies the schema that defines the field
string SchemaXml { get; set; }|
System.String
|
Specifies the ServerRelativeUrl of the of the web site folder in which the field belongs to
string Scope { get; }|
System.String
|
Specifies whether the field can be changed or deleted
bool Sealed { get; set; }|
System.Boolean
|
Gets or sets the Id of the group to which the users to select belong to
int SelectionGroup { get; set; }|
System.Int32
|
Gets or sets the selection mode of the user field
FieldUserSelectionMode SelectionMode { get; set; }|
FieldUserSelectionMode
|
Gets or Sets whether the field should be shown as percentage Valid for Number field, Calculated field
bool ShowAsPercentage { get; set; }|
System.Boolean
|
Represents status to determine whether filters pane will show the field
ShowInFiltersPaneStatus ShowInFiltersPane { get; set; }|
ShowInFiltersPaneStatus
|
Returns whether the field can be sorted
bool Sortable { get; }|
System.Boolean
|
Gets or sets the GUID that identifies the TermStore object, which contains the Enterprise Keywords for the site that the current TaxonomyField belongs to.
Guid SspId { get; set; }|
Guid
|
Specifies the static name of the field
string StaticName { get; }|
System.String
|
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.
string TargetTemplate { get; set; }|
System.String
|
Gets or sets the GUID of the TermSet object that contains the Term objects used by the current TaxonomyField object.
Guid TermSetId { get; set; }|
Guid
|
Gets or sets the GUID that identifies the hidden text field in an item.
Guid TextField { get; set; }|
Guid
|
Gets or Sets the title of the field
string Title { get; set; }|
System.String
|
Specifies the FieldTypeKind of the field as a string value
string TypeAsString { get; }|
System.String
|
Specifies the display name for FieldTypeKind of the field
string TypeDisplayName { get; }|
System.String
|
Specifies the description of the FieldTypeKind of the field
string TypeShortDescription { get; }|
System.String
|
Gets or sets a value that specifies whether the field supports unlimited length in document libraries.
bool UnlimitedLengthInDocumentLibrary { get; set; }|
System.Boolean
|
Gets or sets a Boolean value that specifies whether the TaxonomyField object is linked to a customized TermSet object.
bool UserCreated { get; set; }|
System.Boolean
|
Specifies the formula referred by the field and gets evaluated when a list item is added or updated in the list
string ValidationFormula { get; set; }|
System.String
|
Specifies the message to display if validation formula fails for the field when a list item is added or updated in the list
string ValidationMessage { get; set; }|
System.String
|
Creates a new IFieldLocationValue object
IFieldLocationValue NewFieldLocationValue(string displayName, double latitude, double longitude)|
System.String
displayName
Name to display for this location |
|
System.Double
latitude
Latitude for the location |
|
System.Double
longitude
Longitude for the location |
|
IFieldLocationValue
Configured IFieldLocationValue object |
Creates a new IFieldLookupValue object
IFieldLookupValue NewFieldLookupValue(int lookupId)|
System.Int32
lookupId
Id of the lookup value |
|
IFieldLookupValue
Configured IFieldLookupValue object |
Creates a new IFieldTaxonomyValue object
IFieldTaxonomyValue NewFieldTaxonomyValue(Guid termId, string label, int wssId = null)|
Guid
termId
Name of the term to set |
|
System.String
label
Label of the term to set |
|
System.Int32
wssId
Optionally provide the wssId value |
|
IFieldTaxonomyValue
Configured IFieldTaxonomyValue object |
Creates a new IFieldUrlValue object
IFieldUrlValue NewFieldUrlValue(string url, string description = null)|
System.String
url
Url value |
|
System.String
description
Optional description value |
|
IFieldUrlValue
Configured IFieldUrlValue object |
Creates a new IFieldUserValue object
IFieldUserValue NewFieldUserValue(ISharePointPrincipal principal)| ISharePointPrincipal principal |
|
IFieldUserValue
Configured IFieldUserValue object |
Creates a new IFieldUserValue object
IFieldUserValue NewFieldUserValue(int userId)|
System.Int32
userId
Id of the user |
|
IFieldUserValue
Configured IFieldUserValue object |
Creates a new collection to hold IFieldValue objects
IFieldValueCollection NewFieldValueCollection()|
IFieldValueCollection
|
Creates a new collection to hold IFieldTaxonomyValue objects
IFieldValueCollection NewFieldValueCollection(IEnumerable<KeyValuePair<Guid, string>> fieldValues)|
IEnumerable<KeyValuePair<Guid, System.String>>
fieldValues
Collection of field values to add |
|
IFieldValueCollection
|
Creates a new collection to hold IFieldValue objects
IFieldValueCollection NewFieldValueCollection(IEnumerable<IFieldValue> fieldValues)|
IEnumerable<IFieldValue>
fieldValues
Collection of field values to add |
|
IFieldValueCollection
|
Configure the visibility of the field in a Display form
void SetShowInDisplayForm(bool show)|
System.Boolean
show
True when the field will be configured as visible (= default), false otherwise |
Configure the visibility of the field in a Display form
Task SetShowInDisplayFormAsync(bool show)|
System.Boolean
show
True when the field will be configured as visible (= default), false otherwise |
|
Task
|
Configure the visibility of the field in a Edit form
void SetShowInEditForm(bool show)|
System.Boolean
show
True when the field will be configured as visible (= default), false otherwise |
Configure the visibility of the field in a Edit form
Task SetShowInEditFormAsync(bool show)|
System.Boolean
show
True when the field will be configured as visible (= default), false otherwise |
|
Task
|
Configure the visibility of the field in a New form
void SetShowInNewForm(bool show)|
System.Boolean
show
True when the field will be configured as visible (= default), false otherwise |
Configure the visibility of the field in a New form
Task SetShowInNewFormAsync(bool show)|
System.Boolean
show
True when the field will be configured as visible (= default), false otherwise |
|
Task
|
Updates the field and pushes changes down to lists consuming this field
void UpdateAndPushChanges()Updates the field and pushes changes down to lists consuming this field
Task UpdateAndPushChangesAsync()|
Task
|
Updates the field and pushes changes down to lists consuming this field
void UpdateAndPushChangesBatch()Updates the field and pushes changes down to lists consuming this field
void UpdateAndPushChangesBatch(Batch batch)|
Batch
batch
Batch to add this request to |
Updates the field and pushes changes down to lists consuming this field
Task UpdateAndPushChangesBatchAsync()|
Task
|
Updates the field and pushes changes down to lists consuming this field
Task UpdateAndPushChangesBatchAsync(Batch batch)|
Batch
batch
Batch to add this request to |
|
Task
|