Search Results for

    Show / Hide Table of Contents

    Class CommonFieldOptions

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

    Inheritance
    System.Object
    CommonFieldOptions
    FieldBooleanOptions
    FieldCalculatedOptions
    FieldChoiceMultiOptions
    FieldCurrencyOptions
    FieldDateTimeOptions
    FieldLookupOptions
    FieldMultilineTextOptions
    FieldNumberOptions
    FieldTaxonomyOptions
    FieldTextOptions
    FieldUrlOptions
    FieldUserOptions
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public abstract class CommonFieldOptions : object

    Properties

    AddToDefaultView

    Add this field to the default view

    Declaration
    public bool AddToDefaultView { get; set; }
    Property Value
    System.Boolean

    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

    Declaration
    public string CustomFormatter { get; set; }
    Property Value
    System.String

    DefaultFormula

    Sets the default formula of the field

    Declaration
    public string DefaultFormula { get; set; }
    Property Value
    System.String

    Description

    Sets the description of the field

    Declaration
    public string Description { get; set; }
    Property Value
    System.String

    EnforceUniqueValues

    Sets whether the field enforces unique values

    Declaration
    public bool? EnforceUniqueValues { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    Group

    Sets the group of the field

    Declaration
    public string Group { get; set; }
    Property Value
    System.String

    Hidden

    Sets whether the field is hidden

    Declaration
    public bool? Hidden { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    Id

    Guid of the field

    Declaration
    public Guid? Id { get; set; }
    Property Value
    System.Nullable<Guid>

    Indexed

    Sets whether the field is indexed

    Declaration
    public bool? Indexed { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    InternalName

    Set a specific internal name for the field

    Declaration
    public string InternalName { get; set; }
    Property Value
    System.String

    Options

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

    Declaration
    public AddFieldOptionsFlags Options { get; set; }
    Property Value
    AddFieldOptionsFlags

    Required

    Sets whether the field is required

    Declaration
    public bool? Required { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    ShowInEditForm

    Show this field on the list's edit form

    Declaration
    public bool? ShowInEditForm { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    ShowInNewForm

    Show this field on the list's new form

    Declaration
    public bool? ShowInNewForm { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    ShowInViewForms

    Show this field on the list's view forms

    Declaration
    public bool? ShowInViewForms { get; set; }
    Property Value
    System.Nullable<System.Boolean>

    ValidationFormula

    Sets the validation formula of the field

    Declaration
    public string ValidationFormula { get; set; }
    Property Value
    System.String

    ValidationMessage

    Sets the validation message of the field

    Declaration
    public string ValidationMessage { get; set; }
    Property Value
    System.String

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer