Search Results for

    Show / Hide Table of Contents

    Class Navigation

    The Navigation configurations of the Provisioning Template

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

    Constructors

    Navigation()

    Constructor for Navigation class

    Declaration
    public Navigation()

    Navigation(GlobalNavigation, CurrentNavigation, StructuralNavigation)

    Constructor for Navigation class

    Declaration
    public Navigation(GlobalNavigation globalNavigation = null, CurrentNavigation currentNavigation = null, StructuralNavigation searchNavigation = null)
    Parameters
    GlobalNavigation globalNavigation

    GlobalNavigation object

    CurrentNavigation currentNavigation

    CurrentNavigation object

    StructuralNavigation searchNavigation

    SearchNavigation object

    Properties

    AddNewPagesToNavigation

    Declares whether the New Page ribbon command will automatically create a navigation item for the newly created page, optional attribute.

    Declaration
    public Boolean AddNewPagesToNavigation { get; set; }
    Property Value
    Boolean

    CreateFriendlyUrlsForNewPages

    Declares whether the New Page ribbon command will automatically create a friendly URL for the newly created page, optional attribute.

    Declaration
    public Boolean CreateFriendlyUrlsForNewPages { get; set; }
    Property Value
    Boolean

    CurrentNavigation

    The Current Navigation settings for the Provisioning Template

    Declaration
    public CurrentNavigation CurrentNavigation { get; }
    Property Value
    CurrentNavigation

    EnableAudienceTargeting

    Declares whether to enable site navigation audience targeting or not, optional attribute.

    Declaration
    public Boolean EnableAudienceTargeting { get; set; }
    Property Value
    Boolean

    EnableTreeView

    Declares whether the tree view has to be enabled at the site level or not, optional attribute.

    Declaration
    public Boolean EnableTreeView { get; set; }
    Property Value
    Boolean

    GlobalNavigation

    The Global Navigation settings for the Provisioning Template

    Declaration
    public GlobalNavigation GlobalNavigation { get; }
    Property Value
    GlobalNavigation

    SearchNavigation

    Defines the Search Navigation settings of the site

    Declaration
    public StructuralNavigation SearchNavigation { get; }
    Property Value
    StructuralNavigation

    Methods

    Equals(Navigation)

    Compares Navigation object based on GlobalNavigation and CurrentNavigation properties.

    Declaration
    public bool Equals(Navigation other)
    Parameters
    Navigation other

    Navigation object

    Returns
    System.Boolean

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

    Equals(Object)

    Compares object with Navigation

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

    Object that represents Navigation

    Returns
    System.Boolean

    true if the current object is equal to the Navigation

    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