Class CommonFieldOptions

Namespace

PnP.Core.Model.SharePoint

Assembly

PnP.Core.dll

Available options for adding most of SharePoint fields (Excepted Lookup fields)

public abstract class CommonFieldOptions

Inheritance

object

CommonFieldOptions

Derived

FieldBooleanOptions

FieldCalculatedOptions

FieldChoiceMultiOptions

FieldCurrencyOptions

FieldDateTimeOptions

FieldLookupOptions

FieldMultilineTextOptions

FieldNumberOptions

FieldTaxonomyOptions

FieldTextOptions

FieldUrlOptions

FieldUserOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AddToDefaultView

Add this field to the default view

public bool AddToDefaultView { get; set; }

Property Value

bool

CustomFormatter

Allows you to set custom formatting JSON (https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting#supported-column-types) on the field

public string CustomFormatter { get; set; }

Property Value

string

DefaultFormula

Sets the default formula of the field

public string DefaultFormula { get; set; }

Property Value

string

Description

Sets the description of the field

public string Description { get; set; }

Property Value

string

EnforceUniqueValues

Sets whether the field enforces unique values

public bool? EnforceUniqueValues { get; set; }

Property Value

bool?

Group

Sets the group of the field

public string Group { get; set; }

Property Value

string

Hidden

Sets whether the field is hidden

public bool? Hidden { get; set; }

Property Value

bool?

Id

Guid of the field

public Guid? Id { get; set; }

Property Value

Guid?

Indexed

Sets whether the field is indexed

public bool? Indexed { get; set; }

Property Value

bool?

InternalName

Set a specific internal name for the field

public string InternalName { get; set; }

Property Value

string

Options

An AddFieldOptionsFlags flag that specifies the field options to be applied during add

public AddFieldOptionsFlags Options { get; set; }

Property Value

AddFieldOptionsFlags

Required

Sets whether the field is required

public bool? Required { get; set; }

Property Value

bool?

ShowInEditForm

Show this field on the list's edit form

public bool? ShowInEditForm { get; set; }

Property Value

bool?

ShowInNewForm

Show this field on the list's new form

public bool? ShowInNewForm { get; set; }

Property Value

bool?

ShowInViewForms

Show this field on the list's view forms

public bool? ShowInViewForms { get; set; }

Property Value

bool?

ValidationFormula

Sets the validation formula of the field

public string ValidationFormula { get; set; }

Property Value

string

ValidationMessage

Sets the validation message of the field

public string ValidationMessage { get; set; }

Property Value

string