Search Results for

    Show / Hide Table of Contents

    Interface IView

    Public interface to define a View object

    Inherited Members
    IDataModel<IView>.Requested
    IDataModel<IView>.HasValue(String)
    IDataModel<IView>.HasChanged(String)
    IDataModel<IView>.IsPropertyAvailable(Expression<Func<IView, Object>>)
    IDataModel<IView>.ArePropertiesAvailable(Expression<Func<IView, Object>>[])
    IDataModel<IView>.EnsureProperties(Expression<Func<IView, Object>>[])
    IDataModel<IView>.EnsurePropertiesAsync(Expression<Func<IView, Object>>[])
    IDataModel<IView>.ExecuteRequestAsync(ApiRequest)
    IDataModel<IView>.ExecuteRequest(ApiRequest)
    IDataModel<IView>.ExecuteRequestBatchAsync(ApiRequest)
    IDataModel<IView>.ExecuteRequestBatch(ApiRequest)
    IDataModel<IView>.ExecuteRequestBatchAsync(Batch, ApiRequest)
    IDataModel<IView>.ExecuteRequestBatch(Batch, ApiRequest)
    IDataModelParent.Parent
    IDataModelWithContext.PnPContext
    IDataModelGet<IView>.GetBatchAsync(Batch, Expression<Func<IView, Object>>[])
    IDataModelGet<IView>.GetAsync(Expression<Func<IView, Object>>[])
    IDataModelLoad<IView>.LoadBatchAsync(Batch, Expression<Func<IView, Object>>[])
    IDataModelLoad<IView>.LoadAsync(Expression<Func<IView, Object>>[])
    IDataModelUpdate.UpdateBatchAsync()
    IDataModelUpdate.UpdateBatchAsync(Batch)
    IDataModelUpdate.UpdateAsync()
    IDataModelUpdate.UpdateBatch()
    IDataModelUpdate.UpdateBatch(Batch)
    IDataModelUpdate.Update()
    IDataModelDelete.DeleteBatchAsync()
    IDataModelDelete.DeleteBatchAsync(Batch)
    IDataModelDelete.DeleteAsync()
    IDataModelDelete.DeleteBatch()
    IDataModelDelete.DeleteBatch(Batch)
    IDataModelDelete.Delete()
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public interface IView : IDataModel<IView>, IDataModelParent, IDataModelWithContext, ISupportModules<IView>, IDataModelGet<IView>, IDataModelLoad<IView>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel

    Properties

    Aggregations

    Specifies the aggregations displayed by the list view. The Aggregations property contains a CAML string.

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

    AggregationsStatus

    Specifies whether the aggregations are shown in the list view

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

    All

    A special property used to add an asterisk to a $select statement

    Declaration
    object All { get; }
    Property Value
    System.Object

    AssociatedContentTypeId

    Gets or sets Associated Content Type Id

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

    BaseViewId

    Specifies the base view identifier of the list view

    Declaration
    string BaseViewId { get; }
    Property Value
    System.String

    CalendarViewStyles

    Gets or sets Calendar View Styles

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

    ColumnWidth

    Gets or sets Column Width

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

    CustomFormatter

    Gets or sets Custom Formatter

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

    DefaultView

    Gets or sets a Boolean value that specifies whether the view is the default view

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

    DefaultViewForContentType

    Gets or sets a Boolean value that specifies whether the view is the default view for the associated content type

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

    EditorModified

    Gets a Boolean value that indicates whether the view was modified in an HTML editor

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

    Formats

    Specifies the definitions for column and row formatting that are used in a datasheet view

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

    GridLayout

    An attribute of the view, specifies the quick edit layout

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

    Hidden

    Gets or sets Hidden

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

    HtmlSchemaXml

    Gets the Html Schema Xml

    Declaration
    string HtmlSchemaXml { get; }
    Property Value
    System.String

    Id

    Gets the Id

    Declaration
    Guid Id { get; }
    Property Value
    Guid

    ImageUrl

    Specifies the server relative or absolute URL of the Image for the List View

    Declaration
    string ImageUrl { get; }
    Property Value
    System.String

    IncludeRootFolder

    Specifies if the Root Folder is included in the List View

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

    JSLink

    An attribute of the view, specifies the Javascript files used for the view.

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

    ListViewXml

    Gets or sets List View Xml

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

    Method

    Specifies the view method for the list view

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

    MobileDefaultView

    Specifies whether the list view is the default for a mobile device

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

    MobileView

    Specifies whether the list view applies to a mobile device

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

    ModerationType

    Specifies the content approval type for the list view. A string that indicates the Content Approval type, which can be one of the following values: HideUnapproved -- Unapproved draft items are hidden from users who only have permission to read items. Contributor -- Pending and rejected items for the current user are displayed. Moderator -- Pending and rejected items for all users are displayed to users who have managed list permissions.

    Declaration
    string ModerationType { get; }
    Property Value
    System.String

    NewDocumentTemplates

    An attribute of the view, indicates what documents/templates are visible in "New" menu of a document library

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

    OrderedView

    Specifies whether users can reorder items through the user interface

    Declaration
    bool OrderedView { get; }
    Property Value
    System.Boolean

    Paged

    Specifies whether the list view supports displaying items across multiple pages

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

    PageRenderType

    Gets the reason why the page is rendered in classic UX, or Modern if the page is in Modern UX

    Declaration
    ListPageRenderType PageRenderType { get; }
    Property Value
    ListPageRenderType

    PersonalView

    Specifies whether the view is a personal view or a public view

    Declaration
    bool PersonalView { get; }
    Property Value
    System.Boolean

    ReadOnlyView

    Specifies if the view is read-only

    Declaration
    bool ReadOnlyView { get; }
    Property Value
    System.Boolean

    RequiresClientIntegration

    Specifies whether this view requires client integration

    Declaration
    bool RequiresClientIntegration { get; }
    Property Value
    System.Boolean

    RowLimit

    Specifies the limit for the number of items that the list view will return per page

    Declaration
    int RowLimit { get; set; }
    Property Value
    System.Int32

    Scope

    Specifies the recursive scope for the list view of a document library

    Declaration
    ViewScope Scope { get; set; }
    Property Value
    ViewScope

    ServerRelativeUrl

    Specifies the server relative URL of the list view page

    Declaration
    string ServerRelativeUrl { get; }
    Property Value
    System.String

    StyleId

    Specifies the identifier of the view style for the list view

    Declaration
    string StyleId { get; }
    Property Value
    System.String

    TabularView

    Gets or sets the TabularView attribute in the View Schema XML

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

    Threaded

    Gets a Boolean value that indicates whether the view is threaded

    Declaration
    bool Threaded { get; }
    Property Value
    System.Boolean

    Title

    Specifies the Display Name of the List View

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

    Toolbar

    Specifies the toolbar (CAML) for the list view

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

    ToolbarTemplateName

    Specifies the name of the toolbar template that is used for the list view toolbar

    Declaration
    string ToolbarTemplateName { get; }
    Property Value
    System.String

    ViewData

    Specifies the view data for the list view

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

    ViewFields

    Gets or sets View Fields

    Declaration
    IViewFieldCollection ViewFields { get; }
    Property Value
    IViewFieldCollection

    ViewJoins

    Specifies the list joins that will be used by the list view

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

    ViewProjectedFields

    Specifies the projected fields that will be used by the list view

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

    ViewQuery

    Specifies the CAML query that will be used by the list view

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

    ViewType

    Specifies the type of the view

    Declaration
    ViewType ViewType { get; }
    Property Value
    ViewType

    ViewType2

    Gets or sets the ViewType2

    Declaration
    ViewType2 ViewType2 { get; set; }
    Property Value
    ViewType2

    Methods

    AddViewField(String)

    Adds a field to the current view

    Declaration
    void AddViewField(string internalFieldName)
    Parameters
    System.String internalFieldName

    Internal name of the field to add

    AddViewFieldAsync(String)

    Adds a field to the current view

    Declaration
    Task AddViewFieldAsync(string internalFieldName)
    Parameters
    System.String internalFieldName

    Internal name of the field to add

    Returns
    Task

    MoveViewFieldTo(String, Int32)

    Moves a view field to a new position in the view

    Declaration
    void MoveViewFieldTo(string internalFieldName, int newOrder)
    Parameters
    System.String internalFieldName

    Internal name of the view field to move

    System.Int32 newOrder

    New position

    MoveViewFieldToAsync(String, Int32)

    Moves a view field to a new position in the view

    Declaration
    Task MoveViewFieldToAsync(string internalFieldName, int newOrder)
    Parameters
    System.String internalFieldName

    Internal name of the view field to move

    System.Int32 newOrder

    New position

    Returns
    Task

    RemoveViewField(String)

    Removes a field from the current view

    Declaration
    void RemoveViewField(string internalFieldName)
    Parameters
    System.String internalFieldName

    Internal name of the field to remove

    RemoveViewFieldAsync(String)

    Removes a field from the current view

    Declaration
    Task RemoveViewFieldAsync(string internalFieldName)
    Parameters
    System.String internalFieldName

    Internal name of the field to remove

    Returns
    Task

    Extension Methods

    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatchAsync<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.GetBatch<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelGetExtensions.Get<TModel>(IDataModelGet<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatchAsync<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.LoadBatch<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.Load<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    DataModelLoadExtensions.QueryProperties<TModel>(IDataModelLoad<TModel>, Expression<Func<TModel, Object>>[])
    RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)
    RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)
    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer