Interface IView
Public interface to define a View object
Assembly: PnP.Core.dll
Syntax
public interface IView : IDataModel<IView>, IDataModelParent, IDataModelWithContext, ISupportModules<IView>, IDataModelGet<IView>, IDataModelLoad<IView>, IDataModelUpdate, IDataModelDelete, IQueryableDataModel
Properties
Specifies the aggregations displayed by the list view. The Aggregations property contains a CAML string.
Declaration
string Aggregations { get; set; }
Property Value
Specifies whether the aggregations are shown in the list view
Declaration
string AggregationsStatus { get; set; }
Property Value
A special property used to add an asterisk to a $select statement
Declaration
Property Value
Gets or sets Associated Content Type Id
Declaration
string AssociatedContentTypeId { get; set; }
Property Value
Specifies the base view identifier of the list view
Declaration
string BaseViewId { get; }
Property Value
Gets or sets Calendar View Styles
Declaration
string CalendarViewStyles { get; set; }
Property Value
Gets or sets Column Width
Declaration
string ColumnWidth { get; set; }
Property Value
Gets or sets a Boolean value that specifies whether the view is the default view
Declaration
bool DefaultView { get; set; }
Property Value
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
Gets a Boolean value that indicates whether the view was modified in an HTML editor
Declaration
bool EditorModified { get; set; }
Property Value
An attribute of the view, specifies the quick edit layout
Declaration
string GridLayout { get; set; }
Property Value
Declaration
bool Hidden { get; set; }
Property Value
Declaration
string HtmlSchemaXml { get; }
Property Value
Declaration
Property Value
Specifies the server relative or absolute URL of the Image for the List View
Declaration
Property Value
Specifies if the Root Folder is included in the List View
Declaration
bool IncludeRootFolder { get; set; }
Property Value
An attribute of the view, specifies the Javascript files used for the view.
Declaration
string JSLink { get; set; }
Property Value
Gets or sets List View Xml
Declaration
string ListViewXml { get; set; }
Property Value
Specifies the view method for the list view
Declaration
string Method { get; set; }
Property Value
Specifies whether the list view is the default for a mobile device
Declaration
bool MobileDefaultView { get; set; }
Property Value
Specifies whether the list view applies to a mobile device
Declaration
bool MobileView { get; set; }
Property Value
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
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
Specifies whether users can reorder items through the user interface
Declaration
bool OrderedView { get; }
Property Value
Specifies whether the list view supports displaying items across multiple pages
Declaration
Property Value
Specifies whether the view is a personal view or a public view
Declaration
bool PersonalView { get; }
Property Value
Specifies if the view is read-only
Declaration
bool ReadOnlyView { get; }
Property Value
Specifies whether this view requires client integration
Declaration
bool RequiresClientIntegration { get; }
Property Value
Specifies the limit for the number of items that the list view will return per page
Declaration
int RowLimit { get; set; }
Property Value
Specifies the recursive scope for the list view of a document library
Declaration
ViewScope Scope { get; set; }
Property Value
Specifies the server relative URL of the list view page
Declaration
string ServerRelativeUrl { get; }
Property Value
Specifies the identifier of the view style for the list view
Declaration
Property Value
Gets or sets the TabularView attribute in the View Schema XML
Declaration
bool TabularView { get; set; }
Property Value
Gets a Boolean value that indicates whether the view is threaded
Declaration
Property Value
Specifies the Display Name of the List View
Declaration
string Title { get; set; }
Property Value
Specifies the view data for the list view
Declaration
string ViewData { get; set; }
Property Value
Declaration
IViewFieldCollection ViewFields { get; }
Property Value
Specifies the list joins that will be used by the list view
Declaration
string ViewJoins { get; set; }
Property Value
Specifies the projected fields that will be used by the list view
Declaration
string ViewProjectedFields { get; set; }
Property Value
Specifies the CAML query that will be used by the list view
Declaration
string ViewQuery { get; set; }
Property Value
Specifies the type of the view
Declaration
ViewType ViewType { get; }
Property Value
Gets or sets the ViewType2
Declaration
ViewType2 ViewType2 { get; set; }
Property Value
Methods
Adds a field to the current view
Declaration
void AddViewField(string internalFieldName)
Parameters
System.String
internalFieldName
Internal name of the field to add
|
Adds a field to the current view
Declaration
Task AddViewFieldAsync(string internalFieldName)
Parameters
System.String
internalFieldName
Internal name of the field to add
|
Returns
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
|
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
Removes a field from the current view
Declaration
void RemoveViewField(string internalFieldName)
Parameters
System.String
internalFieldName
Internal name of the field to remove
|
Removes a field from the current view
Declaration
Task RemoveViewFieldAsync(string internalFieldName)
Parameters
System.String
internalFieldName
Internal name of the field to remove
|
Returns
Extension Methods