Search Results for

    Show / Hide Table of Contents

    Class FieldRef

    Represents a Field XML Markup that is used to define information about a field

    Inheritance
    System.Object
    BaseModel
    FieldRef
    Inherited Members
    BaseModel.ParentTemplate
    Namespace: PnP.Framework.Provisioning.Model
    Assembly: PnP.Framework.dll
    Syntax
    public class FieldRef : BaseModel, IProvisioningTemplateDescendant

    Constructors

    FieldRef()

    Constructor for FieldRef class

    Declaration
    public FieldRef()

    FieldRef(String)

    Constructor for FieldRef class

    Declaration
    public FieldRef(string fieldRefName)
    Parameters
    System.String fieldRefName

    Name of the Field Reference

    Properties

    DisplayName

    Gets or sets the Display Name of the field. Only applicable to fields associated with lists.

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

    Hidden

    Gets or sets if the field is Hidden

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

    Id

    Gets ot sets the ID of the referenced field

    Declaration
    public Guid Id { get; set; }
    Property Value
    Guid

    Name

    Gets or sets the name of the field link. This will not change the internal name of the field.

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

    ReadOnly

    Gets or sets if the field is read only

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

    Remove

    Declares if the FieldRef should be Removed from the list or library, optional attribute.

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

    Required

    Gets or sets if the field is Required

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

    ShowInDisplayForm

    Gets or sets if the field is shown in the display form

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

    UpdateChildren

    Declares whether the current field reference has to be udpated on inherited content types

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

    Methods

    Equals(FieldRef)

    Compares FieldRef object based on Id, Required, Hidden, Remove, and UpdateChildren properties.

    Declaration
    public bool Equals(FieldRef other)
    Parameters
    FieldRef other

    FieldRef object

    Returns
    System.Boolean

    true if the FieldRef object is equal to the current object; otherwise, false.

    Equals(Object)

    Compares object with FieldRef

    Declaration
    public override bool Equals(object obj)
    Parameters
    System.Object obj

    Object that represents FieldRef

    Returns
    System.Boolean

    true if the current object is equal to the FieldRef

    GetHashCode()

    Gets the hash code

    Declaration
    public override int GetHashCode()
    Returns
    System.Int32

    Returns HashCode

    Extension Methods

    ValidationExtensions.ValidateNotNullOrEmpty<T>(T, String)
    ObjectExtensions.Set<TObject, T>(TObject, Expression<Func<TObject, T>>, T, Boolean, Boolean)
    ObjectExtensions.GetPublicInstancePropertyValue(Object, String)
    ObjectExtensions.GetPublicInstanceProperty(Object, String)
    ObjectExtensions.SetPublicInstancePropertyValue(Object, String, Object)
    Extensions.ToByteArray(Object)
    Back to top PnP Framework
    Generated by DocFX with Material UI
    spacer