From 545022774ec9ff7f429d5df073425190c6017cb5 Mon Sep 17 00:00:00 2001 From: jansenbe Date: Mon, 12 Feb 2024 20:04:27 +0000 Subject: [PATCH] Commit from GitHub Actions (Refresh documentation) --- ...re.Model.SharePoint.FieldLocationValue.html | 4 ++-- ...re.Model.SharePoint.FieldNumberOptions.html | 6 +++--- api/PnP.Core.Model.SharePoint.IField.html | 4 ++-- ...e.Model.SharePoint.IFieldLocationValue.html | 4 ++-- ...P.Core.Model.SharePoint.IHeaderOptions.html | 8 ++++---- api/PnP.Core.Model.SharePoint.IPage.html | 4 ++-- api/PnP.Core.Model.SharePoint.IPageHeader.html | 4 ++-- ...ore.Model.Teams.EventCoordinateOptions.html | 10 +++++----- ...odel.Teams.IGraphOutlookGeoCoordinates.html | 10 +++++----- index.json | 18 +++++++++--------- manifest.json | 18 +++++++++--------- 11 files changed, 45 insertions(+), 45 deletions(-) diff --git a/api/PnP.Core.Model.SharePoint.FieldLocationValue.html b/api/PnP.Core.Model.SharePoint.FieldLocationValue.html index d519ab317e..0d6d8ae938 100644 --- a/api/PnP.Core.Model.SharePoint.FieldLocationValue.html +++ b/api/PnP.Core.Model.SharePoint.FieldLocationValue.html @@ -324,7 +324,7 @@
Property Value
@@ -416,7 +416,7 @@
Property Value
- System.Double + Double

diff --git a/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html b/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html index d26f18745d..8e26021dee 100644 --- a/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html +++ b/api/PnP.Core.Model.SharePoint.FieldNumberOptions.html @@ -241,7 +241,7 @@
Property Value
- System.Double + Double

@@ -285,7 +285,7 @@
Property Value
- Nullable<System.Double> + Nullable<Double>

@@ -329,7 +329,7 @@
Property Value
- Nullable<System.Double> + Nullable<Double>

diff --git a/api/PnP.Core.Model.SharePoint.IField.html b/api/PnP.Core.Model.SharePoint.IField.html index 634fad08ef..5c689c537d 100644 --- a/api/PnP.Core.Model.SharePoint.IField.html +++ b/api/PnP.Core.Model.SharePoint.IField.html @@ -2484,7 +2484,7 @@
Property Value
- Nullable<System.Double> + Nullable<Double>

@@ -2572,7 +2572,7 @@
Property Value
- System.Double + Double

diff --git a/api/PnP.Core.Model.SharePoint.IFieldLocationValue.html b/api/PnP.Core.Model.SharePoint.IFieldLocationValue.html index 99643e1822..0efe8a1a0a 100644 --- a/api/PnP.Core.Model.SharePoint.IFieldLocationValue.html +++ b/api/PnP.Core.Model.SharePoint.IFieldLocationValue.html @@ -275,7 +275,7 @@
Property Value
- System.Double + Double

@@ -363,7 +363,7 @@
Property Value
- System.Double + Double

diff --git a/api/PnP.Core.Model.SharePoint.IHeaderOptions.html b/api/PnP.Core.Model.SharePoint.IHeaderOptions.html index 9d8f628dbb..968ce55588 100644 --- a/api/PnP.Core.Model.SharePoint.IHeaderOptions.html +++ b/api/PnP.Core.Model.SharePoint.IHeaderOptions.html @@ -568,7 +568,7 @@
Parameters
- System.Double + Double

- System.Double + Double focalX

X axis focal point for the header image

@@ -576,7 +576,7 @@
Parameters
- System.Double + Double focalY

Y axis focal point for the header image

@@ -646,7 +646,7 @@
Parameters
- System.Double + Double focalX

X axis focal point for the header image

@@ -654,7 +654,7 @@
Parameters
- System.Double + Double focalY

Y axis focal point for the header image

diff --git a/api/PnP.Core.Model.SharePoint.IPage.html b/api/PnP.Core.Model.SharePoint.IPage.html index a65ca8f465..8c61d04cbc 100644 --- a/api/PnP.Core.Model.SharePoint.IPage.html +++ b/api/PnP.Core.Model.SharePoint.IPage.html @@ -4379,7 +4379,7 @@
Parameters
- Nullable<System.Double> + Nullable<Double> translateX

X focal point for image

@@ -4387,7 +4387,7 @@
Parameters
- Nullable<System.Double> + Nullable<Double> translateY

Y focal point for image

diff --git a/api/PnP.Core.Model.SharePoint.IPageHeader.html b/api/PnP.Core.Model.SharePoint.IPageHeader.html index 171c6be62c..cba3adeca3 100644 --- a/api/PnP.Core.Model.SharePoint.IPageHeader.html +++ b/api/PnP.Core.Model.SharePoint.IPageHeader.html @@ -578,7 +578,7 @@
Property Value
@@ -622,7 +622,7 @@
Property Value
- Nullable<System.Double> + Nullable<Double>

diff --git a/api/PnP.Core.Model.Teams.EventCoordinateOptions.html b/api/PnP.Core.Model.Teams.EventCoordinateOptions.html index 7683e9c770..75bdfeb585 100644 --- a/api/PnP.Core.Model.Teams.EventCoordinateOptions.html +++ b/api/PnP.Core.Model.Teams.EventCoordinateOptions.html @@ -142,7 +142,7 @@
Property Value
- Nullable<System.Double> + Nullable<Double>

@@ -186,7 +186,7 @@
Property Value
- System.Double + Double

@@ -230,7 +230,7 @@
Property Value
- System.Double + Double

@@ -274,7 +274,7 @@
Property Value
- System.Double + Double

@@ -318,7 +318,7 @@
Property Value
- System.Double + Double

diff --git a/api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html b/api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html index 65b1b3f65b..b9eeb5a0df 100644 --- a/api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html +++ b/api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html @@ -185,7 +185,7 @@
Property Value
- System.Double + Double

@@ -229,7 +229,7 @@
Property Value
- System.Double + Double

@@ -273,7 +273,7 @@
Property Value
- System.Double + Double

@@ -317,7 +317,7 @@
Property Value
- System.Double + Double

@@ -361,7 +361,7 @@
Property Value
- System.Double + Double

diff --git a/index.json b/index.json index f7fdc2faa0..053ad5aede 100644 --- a/index.json +++ b/index.json @@ -1487,7 +1487,7 @@ "api/PnP.Core.Model.SharePoint.FieldLocationValue.html": { "href": "api/PnP.Core.Model.SharePoint.FieldLocationValue.html", "title": "Class FieldLocationValue | PnP Core SDK", - "keywords": "Class FieldLocationValue Represents a location field value Inheritance Object FieldValue FieldLocationValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldLocationValue : FieldValue, IFieldLocationValue, IFieldValue Constructors FieldLocationValue() Default constructor Declaration public FieldLocationValue() Properties City City Declaration public string City { get; } Property Value String Implements IFieldLocationValue.City CountryOrRegion Country of region Declaration public string CountryOrRegion { get; } Property Value String Implements IFieldLocationValue.CountryOrRegion DisplayName Name identifiying this location Declaration public string DisplayName { get; } Property Value String Implements IFieldLocationValue.DisplayName Latitude Latitude of the location Declaration public double Latitude { get; } Property Value System.Double Implements IFieldLocationValue.Latitude LocationUri Uri identifying this location Declaration public string LocationUri { get; } Property Value String Implements IFieldLocationValue.LocationUri Longitude Longitude of the location Declaration public double Longitude { get; } Property Value System.Double Implements IFieldLocationValue.Longitude PostalCode Postal/zip code Declaration public string PostalCode { get; } Property Value String Implements IFieldLocationValue.PostalCode State State Declaration public string State { get; } Property Value String Implements IFieldLocationValue.State Street Streetname Declaration public string Street { get; } Property Value String Implements IFieldLocationValue.Street" + "keywords": "Class FieldLocationValue Represents a location field value Inheritance Object FieldValue FieldLocationValue Inherited Members FieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public sealed class FieldLocationValue : FieldValue, IFieldLocationValue, IFieldValue Constructors FieldLocationValue() Default constructor Declaration public FieldLocationValue() Properties City City Declaration public string City { get; } Property Value String Implements IFieldLocationValue.City CountryOrRegion Country of region Declaration public string CountryOrRegion { get; } Property Value String Implements IFieldLocationValue.CountryOrRegion DisplayName Name identifiying this location Declaration public string DisplayName { get; } Property Value String Implements IFieldLocationValue.DisplayName Latitude Latitude of the location Declaration public double Latitude { get; } Property Value Double Implements IFieldLocationValue.Latitude LocationUri Uri identifying this location Declaration public string LocationUri { get; } Property Value String Implements IFieldLocationValue.LocationUri Longitude Longitude of the location Declaration public double Longitude { get; } Property Value Double Implements IFieldLocationValue.Longitude PostalCode Postal/zip code Declaration public string PostalCode { get; } Property Value String Implements IFieldLocationValue.PostalCode State State Declaration public string State { get; } Property Value String Implements IFieldLocationValue.State Street Streetname Declaration public string Street { get; } Property Value String Implements IFieldLocationValue.Street" }, "api/PnP.Core.Model.SharePoint.FieldLookupOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldLookupOptions.html", @@ -1507,7 +1507,7 @@ "api/PnP.Core.Model.SharePoint.FieldNumberOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldNumberOptions.html", "title": "Class FieldNumberOptions | PnP Core SDK", - "keywords": "Class FieldNumberOptions Available options for SharePoint Number fields Inheritance Object CommonFieldOptions FieldNumberOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldNumberOptions : CommonFieldOptions Properties Decimals How many decimals to show Declaration public int? Decimals { get; set; } Property Value Nullable < Int32 > DefaultValue Default value set on the field Declaration public double? DefaultValue { get; set; } Property Value Nullable < System.Double > MaximumValue Gets or sets a value that specifies the maximum allowed value for the field. Declaration public double? MaximumValue { get; set; } Property Value Nullable < System.Double > MinimumValue Gets or sets a value that specifies the minimum allowed value for the field. Declaration public double? MinimumValue { get; set; } Property Value Nullable < System.Double > ShowAsPercentage Gets or sets whether the field must be shown as percentage. Declaration public bool? ShowAsPercentage { get; set; } Property Value Nullable < Boolean >" + "keywords": "Class FieldNumberOptions Available options for SharePoint Number fields Inheritance Object CommonFieldOptions FieldNumberOptions Inherited Members CommonFieldOptions.Id CommonFieldOptions.Required CommonFieldOptions.AddToDefaultView CommonFieldOptions.Options CommonFieldOptions.Description CommonFieldOptions.InternalName CommonFieldOptions.DefaultFormula CommonFieldOptions.EnforceUniqueValues CommonFieldOptions.Group CommonFieldOptions.Hidden CommonFieldOptions.Indexed CommonFieldOptions.ValidationFormula CommonFieldOptions.ValidationMessage CommonFieldOptions.ShowInEditForm CommonFieldOptions.ShowInViewForms CommonFieldOptions.ShowInNewForm CommonFieldOptions.CustomFormatter Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public class FieldNumberOptions : CommonFieldOptions Properties Decimals How many decimals to show Declaration public int? Decimals { get; set; } Property Value Nullable < Int32 > DefaultValue Default value set on the field Declaration public double? DefaultValue { get; set; } Property Value Nullable < Double > MaximumValue Gets or sets a value that specifies the maximum allowed value for the field. Declaration public double? MaximumValue { get; set; } Property Value Nullable < Double > MinimumValue Gets or sets a value that specifies the minimum allowed value for the field. Declaration public double? MinimumValue { get; set; } Property Value Nullable < Double > ShowAsPercentage Gets or sets whether the field must be shown as percentage. Declaration public bool? ShowAsPercentage { get; set; } Property Value Nullable < Boolean >" }, "api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html": { "href": "api/PnP.Core.Model.SharePoint.FieldTaxonomyOptions.html", @@ -1837,7 +1837,7 @@ "api/PnP.Core.Model.SharePoint.IField.html": { "href": "api/PnP.Core.Model.SharePoint.IField.html", "title": "Interface IField | PnP Core SDK", - "keywords": "Interface IField Public interface to define a Field object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) 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 IField : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowDisplay Gets or sets whether to allow display if the user name Declaration bool AllowDisplay { get; set; } Property Value Boolean AllowHyperlink Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field. Declaration bool AllowHyperlink { get; set; } Property Value Boolean AllowMultipleValues Gets or sets whether the lookup fields allows multiple values Declaration bool AllowMultipleValues { get; set; } Property Value Boolean AnchorId Gets or sets the GUID of the anchor Term object for a TaxonomyField Declaration Guid AnchorId { get; set; } Property Value Guid AppendOnly Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms. Declaration bool AppendOnly { get; set; } Property Value Boolean AutoIndexed Gets or sets a Boolean value that specifies whether the field is auto-indexed Declaration bool AutoIndexed { get; set; } Property Value Boolean CanBeDeleted Specifies whether or not the field can be deleted Declaration bool CanBeDeleted { get; } Property Value Boolean Choices Gets or sets the choices of choice field Declaration string[] Choices { get; set; } Property Value String [] ClientSideComponentId Gets or Sets the client side component Id associated with the field Declaration Guid ClientSideComponentId { get; set; } Property Value Guid ClientSideComponentProperties Gets or Sets the properties of the client side component associated with the field Declaration string ClientSideComponentProperties { get; set; } Property Value String ClientValidationFormula Gets or Sets the validation formula Declaration string ClientValidationFormula { get; set; } Property Value String ClientValidationMessage Gets or Sets the client validation message of the field Declaration string ClientValidationMessage { get; set; } Property Value String CreateValuesInEditForm Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool CreateValuesInEditForm { get; set; } Property Value Boolean CurrencyLocaleId Gets or Sets the Locale Id of the currency Declaration int CurrencyLocaleId { get; set; } Property Value Int32 CustomFormatter Gets or Sets custom formatter of the field Declaration string CustomFormatter { get; set; } Property Value String DateFormat Gets or Sets the Date Format Valid for DateTime field, Calculated field Declaration DateTimeFieldFormatType DateFormat { get; set; } Property Value DateTimeFieldFormatType DateTimeCalendarType Gets or sets the type of calendar to use of a DateTime field Declaration CalendarType DateTimeCalendarType { get; set; } Property Value CalendarType DefaultFormula Gets or sets the default formula for a calculated field Declaration string DefaultFormula { get; set; } Property Value String DefaultValue Gets or Sets the default value of the field Declaration object DefaultValue { get; set; } Property Value Object DependentLookupInternalNames Gets the dependent lookup internal names of a lookup field Declaration string[] DependentLookupInternalNames { get; } Property Value String [] Description Gets or Sets the description of the field Declaration string Description { get; set; } Property Value String Direction Specifies the direction of the reading order for the field. A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left or none Declaration string Direction { get; set; } Property Value String DisplayFormat Gets or Sets the display format of the field CAUTION: Is an integer value since according to field type, the display format enum may change Declaration int DisplayFormat { get; set; } Property Value Int32 EditFormat Determines whether to display the choice field as radio buttons or as a drop-down list Declaration ChoiceFormatType EditFormat { get; set; } Property Value ChoiceFormatType EnableLookup Gets or sets whether the lookup should be enabled for computed field Declaration bool EnableLookup { get; set; } Property Value Boolean EnforceUniqueValues Gets or Sets whether the field enforces unique values Declaration bool EnforceUniqueValues { get; set; } Property Value Boolean EntityPropertyName Gets the name of the entity property for the list item entity that uses this field Declaration string EntityPropertyName { get; } Property Value String FieldTypeKind Gets or Sets the field type kind of the field https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543%28v%3doffice.15%29 Declaration FieldType FieldTypeKind { get; } Property Value FieldType FillInChoice Gets or sets whether choice field can be filled in by user Declaration bool FillInChoice { get; set; } Property Value Boolean Filterable Returns whether the field can be filtered Declaration bool Filterable { get; } Property Value Boolean Formula Specifies the formula that is used for calculation in the field Declaration string Formula { get; set; } Property Value String FriendlyDisplayFormat Gets or sets the friendly format type of a DateTime field Declaration DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; } Property Value DateTimeFieldFriendlyFormatType FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type. Declaration bool FromBaseType { get; } Property Value Boolean Group Gets or Sets the group of the field Declaration string Group { get; set; } Property Value String Hidden Specifies whether the field is displayed in the list Declaration bool Hidden { get; set; } Property Value Boolean Id Provides the id of the field Declaration Guid Id { get; } Property Value Guid Indexed Gets or Sets whether the field is indexed Declaration bool Indexed { get; set; } Property Value Boolean IndexStatus Describes whether a field is indexed, and whether the data in the index is complete Declaration FieldIndexStatus IndexStatus { get; } Property Value FieldIndexStatus InternalName Specifies the internal name of the field Declaration string InternalName { get; } Property Value String IsAnchorValid Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid. Declaration bool IsAnchorValid { get; } Property Value Boolean IsDependentLookup Check whether a lookup field is a dependent lookup field Declaration bool IsDependentLookup { get; } Property Value Boolean IsKeyword Gets or sets a Boolean value that indicates whether the TaxonomyField value points to the Enterprise Keywords TermSet object. Declaration bool IsKeyword { get; set; } Property Value Boolean IsPathRendered Gets or sets a Boolean value that specifies whether the default Label objects of all the parent Term objects of a Term in the TaxonomyField object will be rendered in addition to the default label of that Term. Declaration bool IsPathRendered { get; set; } Property Value Boolean IsRelationship Specifies whether this Lookup field is discoverable from the List being looked up to Declaration bool IsRelationship { get; set; } Property Value Boolean IsTermSetValid Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId property exists and is available for tagging. Declaration bool IsTermSetValid { get; } Property Value Boolean JSLink Gets or sets the name of an external JS file containing any client rendering logic for fields of this type Declaration string JSLink { get; set; } Property Value String LookupField Specifies the name of the Field used as the lookup values Declaration string LookupField { get; set; } Property Value String LookupList Specifies the id (GUID) of the List that contains the Field to use as the lookup values Declaration string LookupList { get; set; } Property Value String LookupWebId Specifies the id of the Site that contains the List which contains the Field used as the lookup values Declaration Guid LookupWebId { get; set; } Property Value Guid Mappings Gets the mappings of a choice field Declaration string Mappings { get; } Property Value String MaximumValue Gets or sets the maximum value of a number field Declaration double MaximumValue { get; set; } Property Value System.Double MaxLength Specifies the maximum number of characters that can be typed in the field Declaration int MaxLength { get; set; } Property Value Int32 MinimumValue Gets or sets the minimum value of a number field Declaration double MinimumValue { get; set; } Property Value System.Double NumberOfLines Gets or sets a value that specifies the number of lines of text to display for the field. Declaration int NumberOfLines { get; set; } Property Value Int32 Open Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool Open { get; set; } Property Value Boolean OutputType Gets or sets the type of a calculated field output Declaration FieldType OutputType { get; set; } Property Value FieldType Presence Gets or sets whether to display the presence indicator of the user Declaration bool Presence { get; set; } Property Value Boolean PrimaryFieldId Specifies the GUID of the primary lookup field if this is a dependent lookup field. Otherwise, it is empty string Declaration string PrimaryFieldId { get; set; } Property Value String ReadOnlyField Specifies whether values in the field can be modified Declaration bool ReadOnlyField { get; set; } Property Value Boolean RelationshipDeleteBehavior Specifies the Delete Behavior of the Lookup Field Declaration RelationshipDeleteBehaviorType RelationshipDeleteBehavior { get; set; } Property Value RelationshipDeleteBehaviorType Required Gets or Sets whether the field is required Declaration bool Required { get; set; } Property Value Boolean RestrictedMode Gets or sets a value that specifies whether the field supports a subset of rich formatting. Declaration bool RestrictedMode { get; set; } Property Value Boolean RichText Gets or sets a value that specifies whether the field supports rich formatting. Declaration bool RichText { get; set; } Property Value Boolean SchemaXml Specifies the schema that defines the field Declaration string SchemaXml { get; set; } Property Value String Scope Specifies the ServerRelativeUrl of the of the web site folder in which the field belongs to Declaration string Scope { get; } Property Value String Sealed Specifies whether the field can be changed or deleted Declaration bool Sealed { get; set; } Property Value Boolean SelectionGroup Gets or sets the Id of the group to which the users to select belong to Declaration int SelectionGroup { get; set; } Property Value Int32 SelectionMode Gets or sets the selection mode of the user field Declaration FieldUserSelectionMode SelectionMode { get; set; } Property Value FieldUserSelectionMode ShowAsPercentage Gets or Sets whether the field should be shown as percentage Valid for Number field, Calculated field Declaration bool ShowAsPercentage { get; set; } Property Value Boolean ShowInFiltersPane Represents status to determine whether filters pane will show the field Declaration ShowInFiltersPaneStatus ShowInFiltersPane { get; set; } Property Value ShowInFiltersPaneStatus Sortable Returns whether the field can be sorted Declaration bool Sortable { get; } Property Value Boolean SspId Gets or sets the GUID that identifies the TermStore object, which contains the Enterprise Keywords for the site that the current TaxonomyField belongs to. Declaration Guid SspId { get; set; } Property Value Guid StaticName Specifies the static name of the field Declaration string StaticName { get; } Property Value String TargetTemplate Gets or sets the Web-relative URL of the target page that is used to construct the hyperlink on each Term object when the TaxonomyField object is rendered. Declaration string TargetTemplate { get; set; } Property Value String TermSetId Gets or sets the GUID of the TermSet object that contains the Term objects used by the current TaxonomyField object. Declaration Guid TermSetId { get; set; } Property Value Guid TextField Gets or sets the GUID that identifies the hidden text field in an item. Declaration Guid TextField { get; set; } Property Value Guid Title Gets or Sets the title of the field Declaration string Title { get; set; } Property Value String TypeAsString Specifies the FieldTypeKind of the field as a string value Declaration string TypeAsString { get; } Property Value String TypeDisplayName Specifies the display name for FieldTypeKind of the field Declaration string TypeDisplayName { get; } Property Value String TypeShortDescription Specifies the description of the FieldTypeKind of the field Declaration string TypeShortDescription { get; } Property Value String UnlimitedLengthInDocumentLibrary Gets or sets a value that specifies whether the field supports unlimited length in document libraries. Declaration bool UnlimitedLengthInDocumentLibrary { get; set; } Property Value Boolean UserCreated Gets or sets a Boolean value that specifies whether the TaxonomyField object is linked to a customized TermSet object. Declaration bool UserCreated { get; set; } Property Value Boolean ValidationFormula Specifies the formula referred by the field and gets evaluated when a list item is added or updated in the list Declaration string ValidationFormula { get; set; } Property Value String ValidationMessage Specifies the message to display if validation formula fails for the field when a list item is added or updated in the list Declaration string ValidationMessage { get; set; } Property Value String Methods NewFieldLookupValue(Int32) Creates a new IFieldLookupValue object Declaration IFieldLookupValue NewFieldLookupValue(int lookupId) Parameters Int32 lookupId Id of the lookup value Returns IFieldLookupValue Configured IFieldLookupValue object NewFieldTaxonomyValue(Guid, String, Int32) Creates a new IFieldTaxonomyValue object Declaration IFieldTaxonomyValue NewFieldTaxonomyValue(Guid termId, string label, int wssId = null) Parameters Guid termId Name of the term to set String label Label of the term to set Int32 wssId Optionally provide the wssId value Returns IFieldTaxonomyValue Configured IFieldTaxonomyValue object NewFieldUrlValue(String, String) Creates a new IFieldUrlValue object Declaration IFieldUrlValue NewFieldUrlValue(string url, string description = null) Parameters String url Url value String description Optional description value Returns IFieldUrlValue Configured IFieldUrlValue object NewFieldUserValue(ISharePointPrincipal) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(ISharePointPrincipal principal) Parameters ISharePointPrincipal principal ISharePointUser or ISharePointGroup Returns IFieldUserValue Configured IFieldUserValue object NewFieldUserValue(Int32) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(int userId) Parameters Int32 userId Id of the user Returns IFieldUserValue Configured IFieldUserValue object NewFieldValueCollection() Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection() Returns IFieldValueCollection NewFieldValueCollection(IEnumerable>) Creates a new collection to hold IFieldTaxonomyValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable> fieldValues) Parameters IEnumerable < KeyValuePair < Guid , String >> fieldValues Collection of field values to add Returns IFieldValueCollection NewFieldValueCollection(IEnumerable) Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable fieldValues) Parameters IEnumerable < IFieldValue > fieldValues Collection of field values to add Returns IFieldValueCollection SetShowInDisplayForm(Boolean) Configure the visibility of the field in a Display form Declaration void SetShowInDisplayForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInDisplayFormAsync(Boolean) Configure the visibility of the field in a Display form Declaration Task SetShowInDisplayFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInEditForm(Boolean) Configure the visibility of the field in a Edit form Declaration void SetShowInEditForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInEditFormAsync(Boolean) Configure the visibility of the field in a Edit form Declaration Task SetShowInEditFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInNewForm(Boolean) Configure the visibility of the field in a New form Declaration void SetShowInNewForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInNewFormAsync(Boolean) Configure the visibility of the field in a New form Declaration Task SetShowInNewFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task UpdateAndPushChanges() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChanges() UpdateAndPushChangesAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesAsync() Returns Task UpdateAndPushChangesBatch() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch() UpdateAndPushChangesBatch(Batch) Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch(Batch batch) Parameters Batch batch Batch to add this request to UpdateAndPushChangesBatchAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync() Returns Task UpdateAndPushChangesBatchAsync(Batch) Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IField Public interface to define a Field object of SharePoint Online Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext IDataModelGet.GetBatchAsync(Batch, Expression>[]) IDataModelGet.GetAsync(Expression>[]) IDataModelLoad.LoadBatchAsync(Batch, Expression>[]) IDataModelLoad.LoadAsync(Expression>[]) 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 IField : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules, IDataModelGet, IDataModelLoad, IDataModelUpdate, IDataModelDelete, IQueryableDataModel Properties All A special property used to add an asterisk to a $select statement Declaration object All { get; } Property Value Object AllowDisplay Gets or sets whether to allow display if the user name Declaration bool AllowDisplay { get; set; } Property Value Boolean AllowHyperlink Gets or sets a value that specifies whether a hyperlink is allowed as a value of the field. Declaration bool AllowHyperlink { get; set; } Property Value Boolean AllowMultipleValues Gets or sets whether the lookup fields allows multiple values Declaration bool AllowMultipleValues { get; set; } Property Value Boolean AnchorId Gets or sets the GUID of the anchor Term object for a TaxonomyField Declaration Guid AnchorId { get; set; } Property Value Guid AppendOnly Gets or sets a value that specifies whether all changes to the value of the field are displayed in list forms. Declaration bool AppendOnly { get; set; } Property Value Boolean AutoIndexed Gets or sets a Boolean value that specifies whether the field is auto-indexed Declaration bool AutoIndexed { get; set; } Property Value Boolean CanBeDeleted Specifies whether or not the field can be deleted Declaration bool CanBeDeleted { get; } Property Value Boolean Choices Gets or sets the choices of choice field Declaration string[] Choices { get; set; } Property Value String [] ClientSideComponentId Gets or Sets the client side component Id associated with the field Declaration Guid ClientSideComponentId { get; set; } Property Value Guid ClientSideComponentProperties Gets or Sets the properties of the client side component associated with the field Declaration string ClientSideComponentProperties { get; set; } Property Value String ClientValidationFormula Gets or Sets the validation formula Declaration string ClientValidationFormula { get; set; } Property Value String ClientValidationMessage Gets or Sets the client validation message of the field Declaration string ClientValidationMessage { get; set; } Property Value String CreateValuesInEditForm Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool CreateValuesInEditForm { get; set; } Property Value Boolean CurrencyLocaleId Gets or Sets the Locale Id of the currency Declaration int CurrencyLocaleId { get; set; } Property Value Int32 CustomFormatter Gets or Sets custom formatter of the field Declaration string CustomFormatter { get; set; } Property Value String DateFormat Gets or Sets the Date Format Valid for DateTime field, Calculated field Declaration DateTimeFieldFormatType DateFormat { get; set; } Property Value DateTimeFieldFormatType DateTimeCalendarType Gets or sets the type of calendar to use of a DateTime field Declaration CalendarType DateTimeCalendarType { get; set; } Property Value CalendarType DefaultFormula Gets or sets the default formula for a calculated field Declaration string DefaultFormula { get; set; } Property Value String DefaultValue Gets or Sets the default value of the field Declaration object DefaultValue { get; set; } Property Value Object DependentLookupInternalNames Gets the dependent lookup internal names of a lookup field Declaration string[] DependentLookupInternalNames { get; } Property Value String [] Description Gets or Sets the description of the field Declaration string Description { get; set; } Property Value String Direction Specifies the direction of the reading order for the field. A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left or none Declaration string Direction { get; set; } Property Value String DisplayFormat Gets or Sets the display format of the field CAUTION: Is an integer value since according to field type, the display format enum may change Declaration int DisplayFormat { get; set; } Property Value Int32 EditFormat Determines whether to display the choice field as radio buttons or as a drop-down list Declaration ChoiceFormatType EditFormat { get; set; } Property Value ChoiceFormatType EnableLookup Gets or sets whether the lookup should be enabled for computed field Declaration bool EnableLookup { get; set; } Property Value Boolean EnforceUniqueValues Gets or Sets whether the field enforces unique values Declaration bool EnforceUniqueValues { get; set; } Property Value Boolean EntityPropertyName Gets the name of the entity property for the list item entity that uses this field Declaration string EntityPropertyName { get; } Property Value String FieldTypeKind Gets or Sets the field type kind of the field https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee540543%28v%3doffice.15%29 Declaration FieldType FieldTypeKind { get; } Property Value FieldType FillInChoice Gets or sets whether choice field can be filled in by user Declaration bool FillInChoice { get; set; } Property Value Boolean Filterable Returns whether the field can be filtered Declaration bool Filterable { get; } Property Value Boolean Formula Specifies the formula that is used for calculation in the field Declaration string Formula { get; set; } Property Value String FriendlyDisplayFormat Gets or sets the friendly format type of a DateTime field Declaration DateTimeFieldFriendlyFormatType FriendlyDisplayFormat { get; set; } Property Value DateTimeFieldFriendlyFormatType FromBaseType Gets a Boolean value that indicates whether the field derives from a base field type. Declaration bool FromBaseType { get; } Property Value Boolean Group Gets or Sets the group of the field Declaration string Group { get; set; } Property Value String Hidden Specifies whether the field is displayed in the list Declaration bool Hidden { get; set; } Property Value Boolean Id Provides the id of the field Declaration Guid Id { get; } Property Value Guid Indexed Gets or Sets whether the field is indexed Declaration bool Indexed { get; set; } Property Value Boolean IndexStatus Describes whether a field is indexed, and whether the data in the index is complete Declaration FieldIndexStatus IndexStatus { get; } Property Value FieldIndexStatus InternalName Specifies the internal name of the field Declaration string InternalName { get; } Property Value String IsAnchorValid Gets a Boolean value that specifies whether the Term object identified by the AnchorId property is valid. Declaration bool IsAnchorValid { get; } Property Value Boolean IsDependentLookup Check whether a lookup field is a dependent lookup field Declaration bool IsDependentLookup { get; } Property Value Boolean IsKeyword Gets or sets a Boolean value that indicates whether the TaxonomyField value points to the Enterprise Keywords TermSet object. Declaration bool IsKeyword { get; set; } Property Value Boolean IsPathRendered Gets or sets a Boolean value that specifies whether the default Label objects of all the parent Term objects of a Term in the TaxonomyField object will be rendered in addition to the default label of that Term. Declaration bool IsPathRendered { get; set; } Property Value Boolean IsRelationship Specifies whether this Lookup field is discoverable from the List being looked up to Declaration bool IsRelationship { get; set; } Property Value Boolean IsTermSetValid Gets a Boolean value that specifies whether the TermSet object identified by the TermSetId property exists and is available for tagging. Declaration bool IsTermSetValid { get; } Property Value Boolean JSLink Gets or sets the name of an external JS file containing any client rendering logic for fields of this type Declaration string JSLink { get; set; } Property Value String LookupField Specifies the name of the Field used as the lookup values Declaration string LookupField { get; set; } Property Value String LookupList Specifies the id (GUID) of the List that contains the Field to use as the lookup values Declaration string LookupList { get; set; } Property Value String LookupWebId Specifies the id of the Site that contains the List which contains the Field used as the lookup values Declaration Guid LookupWebId { get; set; } Property Value Guid Mappings Gets the mappings of a choice field Declaration string Mappings { get; } Property Value String MaximumValue Gets or sets the maximum value of a number field Declaration double MaximumValue { get; set; } Property Value Double MaxLength Specifies the maximum number of characters that can be typed in the field Declaration int MaxLength { get; set; } Property Value Int32 MinimumValue Gets or sets the minimum value of a number field Declaration double MinimumValue { get; set; } Property Value Double NumberOfLines Gets or sets a value that specifies the number of lines of text to display for the field. Declaration int NumberOfLines { get; set; } Property Value Int32 Open Gets or sets a Boolean value that specifies whether the new Term objects can be added to the TermSet while typing in the TaxonomyField editor control. Declaration bool Open { get; set; } Property Value Boolean OutputType Gets or sets the type of a calculated field output Declaration FieldType OutputType { get; set; } Property Value FieldType Presence Gets or sets whether to display the presence indicator of the user Declaration bool Presence { get; set; } Property Value Boolean PrimaryFieldId Specifies the GUID of the primary lookup field if this is a dependent lookup field. Otherwise, it is empty string Declaration string PrimaryFieldId { get; set; } Property Value String ReadOnlyField Specifies whether values in the field can be modified Declaration bool ReadOnlyField { get; set; } Property Value Boolean RelationshipDeleteBehavior Specifies the Delete Behavior of the Lookup Field Declaration RelationshipDeleteBehaviorType RelationshipDeleteBehavior { get; set; } Property Value RelationshipDeleteBehaviorType Required Gets or Sets whether the field is required Declaration bool Required { get; set; } Property Value Boolean RestrictedMode Gets or sets a value that specifies whether the field supports a subset of rich formatting. Declaration bool RestrictedMode { get; set; } Property Value Boolean RichText Gets or sets a value that specifies whether the field supports rich formatting. Declaration bool RichText { get; set; } Property Value Boolean SchemaXml Specifies the schema that defines the field Declaration string SchemaXml { get; set; } Property Value String Scope Specifies the ServerRelativeUrl of the of the web site folder in which the field belongs to Declaration string Scope { get; } Property Value String Sealed Specifies whether the field can be changed or deleted Declaration bool Sealed { get; set; } Property Value Boolean SelectionGroup Gets or sets the Id of the group to which the users to select belong to Declaration int SelectionGroup { get; set; } Property Value Int32 SelectionMode Gets or sets the selection mode of the user field Declaration FieldUserSelectionMode SelectionMode { get; set; } Property Value FieldUserSelectionMode ShowAsPercentage Gets or Sets whether the field should be shown as percentage Valid for Number field, Calculated field Declaration bool ShowAsPercentage { get; set; } Property Value Boolean ShowInFiltersPane Represents status to determine whether filters pane will show the field Declaration ShowInFiltersPaneStatus ShowInFiltersPane { get; set; } Property Value ShowInFiltersPaneStatus Sortable Returns whether the field can be sorted Declaration bool Sortable { get; } Property Value Boolean SspId Gets or sets the GUID that identifies the TermStore object, which contains the Enterprise Keywords for the site that the current TaxonomyField belongs to. Declaration Guid SspId { get; set; } Property Value Guid StaticName Specifies the static name of the field Declaration string StaticName { get; } Property Value String TargetTemplate Gets or sets the Web-relative URL of the target page that is used to construct the hyperlink on each Term object when the TaxonomyField object is rendered. Declaration string TargetTemplate { get; set; } Property Value String TermSetId Gets or sets the GUID of the TermSet object that contains the Term objects used by the current TaxonomyField object. Declaration Guid TermSetId { get; set; } Property Value Guid TextField Gets or sets the GUID that identifies the hidden text field in an item. Declaration Guid TextField { get; set; } Property Value Guid Title Gets or Sets the title of the field Declaration string Title { get; set; } Property Value String TypeAsString Specifies the FieldTypeKind of the field as a string value Declaration string TypeAsString { get; } Property Value String TypeDisplayName Specifies the display name for FieldTypeKind of the field Declaration string TypeDisplayName { get; } Property Value String TypeShortDescription Specifies the description of the FieldTypeKind of the field Declaration string TypeShortDescription { get; } Property Value String UnlimitedLengthInDocumentLibrary Gets or sets a value that specifies whether the field supports unlimited length in document libraries. Declaration bool UnlimitedLengthInDocumentLibrary { get; set; } Property Value Boolean UserCreated Gets or sets a Boolean value that specifies whether the TaxonomyField object is linked to a customized TermSet object. Declaration bool UserCreated { get; set; } Property Value Boolean ValidationFormula Specifies the formula referred by the field and gets evaluated when a list item is added or updated in the list Declaration string ValidationFormula { get; set; } Property Value String ValidationMessage Specifies the message to display if validation formula fails for the field when a list item is added or updated in the list Declaration string ValidationMessage { get; set; } Property Value String Methods NewFieldLookupValue(Int32) Creates a new IFieldLookupValue object Declaration IFieldLookupValue NewFieldLookupValue(int lookupId) Parameters Int32 lookupId Id of the lookup value Returns IFieldLookupValue Configured IFieldLookupValue object NewFieldTaxonomyValue(Guid, String, Int32) Creates a new IFieldTaxonomyValue object Declaration IFieldTaxonomyValue NewFieldTaxonomyValue(Guid termId, string label, int wssId = null) Parameters Guid termId Name of the term to set String label Label of the term to set Int32 wssId Optionally provide the wssId value Returns IFieldTaxonomyValue Configured IFieldTaxonomyValue object NewFieldUrlValue(String, String) Creates a new IFieldUrlValue object Declaration IFieldUrlValue NewFieldUrlValue(string url, string description = null) Parameters String url Url value String description Optional description value Returns IFieldUrlValue Configured IFieldUrlValue object NewFieldUserValue(ISharePointPrincipal) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(ISharePointPrincipal principal) Parameters ISharePointPrincipal principal ISharePointUser or ISharePointGroup Returns IFieldUserValue Configured IFieldUserValue object NewFieldUserValue(Int32) Creates a new IFieldUserValue object Declaration IFieldUserValue NewFieldUserValue(int userId) Parameters Int32 userId Id of the user Returns IFieldUserValue Configured IFieldUserValue object NewFieldValueCollection() Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection() Returns IFieldValueCollection NewFieldValueCollection(IEnumerable>) Creates a new collection to hold IFieldTaxonomyValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable> fieldValues) Parameters IEnumerable < KeyValuePair < Guid , String >> fieldValues Collection of field values to add Returns IFieldValueCollection NewFieldValueCollection(IEnumerable) Creates a new collection to hold IFieldValue objects Declaration IFieldValueCollection NewFieldValueCollection(IEnumerable fieldValues) Parameters IEnumerable < IFieldValue > fieldValues Collection of field values to add Returns IFieldValueCollection SetShowInDisplayForm(Boolean) Configure the visibility of the field in a Display form Declaration void SetShowInDisplayForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInDisplayFormAsync(Boolean) Configure the visibility of the field in a Display form Declaration Task SetShowInDisplayFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInEditForm(Boolean) Configure the visibility of the field in a Edit form Declaration void SetShowInEditForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInEditFormAsync(Boolean) Configure the visibility of the field in a Edit form Declaration Task SetShowInEditFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task SetShowInNewForm(Boolean) Configure the visibility of the field in a New form Declaration void SetShowInNewForm(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise SetShowInNewFormAsync(Boolean) Configure the visibility of the field in a New form Declaration Task SetShowInNewFormAsync(bool show) Parameters Boolean show True when the field will be configured as visible (= default), false otherwise Returns Task UpdateAndPushChanges() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChanges() UpdateAndPushChangesAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesAsync() Returns Task UpdateAndPushChangesBatch() Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch() UpdateAndPushChangesBatch(Batch) Updates the field and pushes changes down to lists consuming this field Declaration void UpdateAndPushChangesBatch(Batch batch) Parameters Batch batch Batch to add this request to UpdateAndPushChangesBatchAsync() Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync() Returns Task UpdateAndPushChangesBatchAsync(Batch) Updates the field and pushes changes down to lists consuming this field Declaration Task UpdateAndPushChangesBatchAsync(Batch batch) Parameters Batch batch Batch to add this request to Returns Task Extension Methods DataModelGetExtensions.GetBatchAsync(IDataModelGet, Expression>[]) DataModelGetExtensions.GetBatchAsync(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Batch, Expression>[]) DataModelGetExtensions.GetBatch(IDataModelGet, Expression>[]) DataModelGetExtensions.Get(IDataModelGet, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Expression>[]) DataModelLoadExtensions.LoadBatchAsync(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Batch, Expression>[]) DataModelLoadExtensions.LoadBatch(IDataModelLoad, Expression>[]) DataModelLoadExtensions.Load(IDataModelLoad, Expression>[]) DataModelLoadExtensions.QueryProperties(IDataModelLoad, Expression>[]) RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.SharePoint.IFieldCollection.html": { "href": "api/PnP.Core.Model.SharePoint.IFieldCollection.html", @@ -1857,7 +1857,7 @@ "api/PnP.Core.Model.SharePoint.IFieldLocationValue.html": { "href": "api/PnP.Core.Model.SharePoint.IFieldLocationValue.html", "title": "Interface IFieldLocationValue | PnP Core SDK", - "keywords": "Interface IFieldLocationValue Represents a location field value Inherited Members IFieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFieldLocationValue : IFieldValue Properties City City Declaration string City { get; } Property Value String CountryOrRegion Country of region Declaration string CountryOrRegion { get; } Property Value String DisplayName Name identifiying this location Declaration string DisplayName { get; } Property Value String Latitude Latitude of the location Declaration double Latitude { get; } Property Value System.Double LocationUri Uri identifying this location Declaration string LocationUri { get; } Property Value String Longitude Longitude of the location Declaration double Longitude { get; } Property Value System.Double PostalCode Postal/zip code Declaration string PostalCode { get; } Property Value String State State Declaration string State { get; } Property Value String Street Streetname Declaration string Street { get; } Property Value String" + "keywords": "Interface IFieldLocationValue Represents a location field value Inherited Members IFieldValue.Field Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IFieldLocationValue : IFieldValue Properties City City Declaration string City { get; } Property Value String CountryOrRegion Country of region Declaration string CountryOrRegion { get; } Property Value String DisplayName Name identifiying this location Declaration string DisplayName { get; } Property Value String Latitude Latitude of the location Declaration double Latitude { get; } Property Value Double LocationUri Uri identifying this location Declaration string LocationUri { get; } Property Value String Longitude Longitude of the location Declaration double Longitude { get; } Property Value Double PostalCode Postal/zip code Declaration string PostalCode { get; } Property Value String State State Declaration string State { get; } Property Value String Street Streetname Declaration string Street { get; } Property Value String" }, "api/PnP.Core.Model.SharePoint.IFieldLookupValue.html": { "href": "api/PnP.Core.Model.SharePoint.IFieldLookupValue.html", @@ -1962,7 +1962,7 @@ "api/PnP.Core.Model.SharePoint.IHeaderOptions.html": { "href": "api/PnP.Core.Model.SharePoint.IHeaderOptions.html", "title": "Interface IHeaderOptions | PnP Core SDK", - "keywords": "Interface IHeaderOptions Options to configure a the site header chrome Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IHeaderOptions Properties Emphasis Gets or sets the value of the header emphasis. Declaration VariantThemeType Emphasis { get; set; } Property Value VariantThemeType HideTitle Gets or sets a value that specifies whether the title in header is hidden on the site. Declaration bool HideTitle { get; set; } Property Value Boolean Layout Gets or sets the value of the header layout. Declaration HeaderLayoutType Layout { get; set; } Property Value HeaderLayoutType LogoAlignment Gets or sets the logo alignment of the site. Declaration LogoAlignment LogoAlignment { get; set; } Property Value LogoAlignment Methods ClearHeaderBackgroundImage() Clears the header background image Declaration void ClearHeaderBackgroundImage() ClearHeaderBackgroundImageAsync() Clears the header background image Declaration Task ClearHeaderBackgroundImageAsync() Returns Task ResetSiteLogo() Sets the out of the box site's logo again. For group connected sites calling this method is equal to calling ResetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration void ResetSiteLogo() ResetSiteLogoAsync() Sets the out of the box site's logo again. For group connected sites calling this method is equal to calling ResetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration Task ResetSiteLogoAsync() Returns Task ResetSiteLogoThumbnail() Sets the out of the box site's logo thumbnail again. For group connected sites we'll default to using siteassets/ siteIcon .jpg if that still exists. Declaration void ResetSiteLogoThumbnail() ResetSiteLogoThumbnailAsync() Sets the out of the box site's logo thumbnail again. For group connected sites we'll default to using siteassets/ siteIcon .jpg if that still exists. Declaration Task ResetSiteLogoThumbnailAsync() Returns Task SetHeaderBackgroundImage(String, Stream, Double, Double, Boolean) Sets the site's header background image. Only can be called when the header layout is set to extended. Declaration void SetHeaderBackgroundImage(string fileName, Stream content, double focalX = null, double focalY = null, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file System.Double focalX X axis focal point for the header image System.Double focalY Y axis focal point for the header image Boolean overwrite Indicates whether the file should be overwritten if already existing. SetHeaderBackgroundImageAsync(String, Stream, Double, Double, Boolean) Sets the site's header background image. Only can be called when the header layout is set to extended. Declaration Task SetHeaderBackgroundImageAsync(string fileName, Stream content, double focalX = null, double focalY = null, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file System.Double focalX X axis focal point for the header image System.Double focalY Y axis focal point for the header image Boolean overwrite Indicates whether the file should be overwritten if already existing. Returns Task SetSiteLogo(String, Stream, Boolean) Sets the site's logo to the provided image. For group connected sites calling this method is equal to calling SetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration void SetSiteLogo(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file Boolean overwrite Indicates whether the file should be overwritten if already existing. SetSiteLogoAsync(String, Stream, Boolean) Sets the site's logo to the provided image. For group connected sites calling this method is equal to calling SetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration Task SetSiteLogoAsync(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file Boolean overwrite Indicates whether the file should be overwritten if already existing. Returns Task SetSiteLogoThumbnail(String, Stream, Boolean) Sets the site's logo thumbnail to the provided image. For group connected sites setting the logo thumbnail will also automatically update the site logo. Declaration void SetSiteLogoThumbnail(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file. Image should in a square aspect ratio Boolean overwrite Indicates whether the file should be overwritten if already existing. SetSiteLogoThumbnailAsync(String, Stream, Boolean) Sets the site's logo thumbnail to the provided image. Declaration Task SetSiteLogoThumbnailAsync(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file. Image should in a square aspect ratio Boolean overwrite Indicates whether the file should be overwritten if already existing. Returns Task" + "keywords": "Interface IHeaderOptions Options to configure a the site header chrome Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IHeaderOptions Properties Emphasis Gets or sets the value of the header emphasis. Declaration VariantThemeType Emphasis { get; set; } Property Value VariantThemeType HideTitle Gets or sets a value that specifies whether the title in header is hidden on the site. Declaration bool HideTitle { get; set; } Property Value Boolean Layout Gets or sets the value of the header layout. Declaration HeaderLayoutType Layout { get; set; } Property Value HeaderLayoutType LogoAlignment Gets or sets the logo alignment of the site. Declaration LogoAlignment LogoAlignment { get; set; } Property Value LogoAlignment Methods ClearHeaderBackgroundImage() Clears the header background image Declaration void ClearHeaderBackgroundImage() ClearHeaderBackgroundImageAsync() Clears the header background image Declaration Task ClearHeaderBackgroundImageAsync() Returns Task ResetSiteLogo() Sets the out of the box site's logo again. For group connected sites calling this method is equal to calling ResetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration void ResetSiteLogo() ResetSiteLogoAsync() Sets the out of the box site's logo again. For group connected sites calling this method is equal to calling ResetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration Task ResetSiteLogoAsync() Returns Task ResetSiteLogoThumbnail() Sets the out of the box site's logo thumbnail again. For group connected sites we'll default to using siteassets/ siteIcon .jpg if that still exists. Declaration void ResetSiteLogoThumbnail() ResetSiteLogoThumbnailAsync() Sets the out of the box site's logo thumbnail again. For group connected sites we'll default to using siteassets/ siteIcon .jpg if that still exists. Declaration Task ResetSiteLogoThumbnailAsync() Returns Task SetHeaderBackgroundImage(String, Stream, Double, Double, Boolean) Sets the site's header background image. Only can be called when the header layout is set to extended. Declaration void SetHeaderBackgroundImage(string fileName, Stream content, double focalX = null, double focalY = null, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file Double focalX X axis focal point for the header image Double focalY Y axis focal point for the header image Boolean overwrite Indicates whether the file should be overwritten if already existing. SetHeaderBackgroundImageAsync(String, Stream, Double, Double, Boolean) Sets the site's header background image. Only can be called when the header layout is set to extended. Declaration Task SetHeaderBackgroundImageAsync(string fileName, Stream content, double focalX = null, double focalY = null, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file Double focalX X axis focal point for the header image Double focalY Y axis focal point for the header image Boolean overwrite Indicates whether the file should be overwritten if already existing. Returns Task SetSiteLogo(String, Stream, Boolean) Sets the site's logo to the provided image. For group connected sites calling this method is equal to calling SetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration void SetSiteLogo(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file Boolean overwrite Indicates whether the file should be overwritten if already existing. SetSiteLogoAsync(String, Stream, Boolean) Sets the site's logo to the provided image. For group connected sites calling this method is equal to calling SetSiteLogoThumbnail as logo and logo thumbnail are both set the same. Declaration Task SetSiteLogoAsync(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file Boolean overwrite Indicates whether the file should be overwritten if already existing. Returns Task SetSiteLogoThumbnail(String, Stream, Boolean) Sets the site's logo thumbnail to the provided image. For group connected sites setting the logo thumbnail will also automatically update the site logo. Declaration void SetSiteLogoThumbnail(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file. Image should in a square aspect ratio Boolean overwrite Indicates whether the file should be overwritten if already existing. SetSiteLogoThumbnailAsync(String, Stream, Boolean) Sets the site's logo thumbnail to the provided image. Declaration Task SetSiteLogoThumbnailAsync(string fileName, Stream content, bool overwrite = false) Parameters String fileName Name of your image file Stream content The contents of the file. Image should in a square aspect ratio Boolean overwrite Indicates whether the file should be overwritten if already existing. Returns Task" }, "api/PnP.Core.Model.SharePoint.IHubSite.html": { "href": "api/PnP.Core.Model.SharePoint.IHubSite.html", @@ -2057,7 +2057,7 @@ "api/PnP.Core.Model.SharePoint.IPage.html": { "href": "api/PnP.Core.Model.SharePoint.IPage.html", "title": "Interface IPage | PnP Core SDK", - "keywords": "Interface IPage A modern SharePoint Page Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPage Properties Controls List of control on this page Declaration List Controls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > DefaultSection The default section of the client side page Declaration ICanvasSection DefaultSection { get; } Property Value ICanvasSection EditorType Returns the editor that was used to create/update this page Declaration EditorType EditorType { get; } Property Value EditorType EntityId Entity id field for topic pages Declaration string EntityId { get; set; } Property Value String EntityRelations Entity relations field for topic pages Declaration string EntityRelations { get; set; } Property Value String EntityType Entity type field for topic pages Declaration string EntityType { get; set; } Property Value String Folder Folder the page lives in (available after saving the page) Declaration string Folder { get; } Property Value String HeaderControls List of controls on this page's header Declaration List HeaderControls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > KeepDefaultWebParts When a page of type Home is created you can opt to only keep the default client side web parts by setting this to true. This also is a way to reset your home page back the the stock one. Declaration bool KeepDefaultWebParts { get; set; } Property Value Boolean LayoutType Layout type of the client side page Declaration PageLayoutType LayoutType { get; set; } Property Value PageLayoutType Name The name of this page (available after saving the page) Declaration string Name { get; } Property Value String PageHeader Returns the page header for this page Declaration IPageHeader PageHeader { get; } Property Value IPageHeader PageId ID value of the page (only available when the page was saved) Declaration int? PageId { get; } Property Value Nullable < Int32 > PageListItem ListItem linked to this page Declaration IListItem PageListItem { get; } Property Value IListItem PagesLibrary Pages library Declaration IList PagesLibrary { get; } Property Value IList PageTitle Title of the client side page Declaration string PageTitle { get; set; } Property Value String PnPContext PnPContext to work with Declaration PnPContext PnPContext { get; } Property Value PnPContext RepostDescription Description of the repost page Declaration string RepostDescription { get; set; } Property Value String RepostSourceItemId Id of the SharePoint IListItem connected to the page being reposted Declaration Guid RepostSourceItemId { get; set; } Property Value Guid RepostSourceListId Id of the SharePoint IList containting the page being reposted Declaration Guid RepostSourceListId { get; set; } Property Value Guid RepostSourceSiteId Id of the SharePoint ISite containting the page being reposted Declaration Guid RepostSourceSiteId { get; set; } Property Value Guid RepostSourceUrl Url being reposted using the repost page Declaration string RepostSourceUrl { get; set; } Property Value String RepostSourceWebId Id of the SharePoint IWeb containting the page being reposted Declaration Guid RepostSourceWebId { get; set; } Property Value Guid ScheduledPublishDate Returns the scheduled publish data of a page (only if publish was scheduled) Declaration DateTime? ScheduledPublishDate { get; } Property Value Nullable < DateTime > Sections List of sections on this page Declaration List Sections { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasSection > SpaceContent Space content field (JSON) for spaces pages Declaration string SpaceContent { get; set; } Property Value String ThumbnailUrl Thumbnail url for the page Declaration string ThumbnailUrl { get; set; } Property Value String Methods AddControl(ICanvasControl) Adds a new control to your client side page using the default ICanvasSection Declaration void AddControl(ICanvasControl control) Parameters ICanvasControl control ICanvasControl to add AddControl(ICanvasControl, ICanvasColumn) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasColumn column) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control AddControl(ICanvasControl, ICanvasColumn, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasColumn column, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control Int32 order Order of the control in the given section AddControl(ICanvasControl, ICanvasSection) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasSection section) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . AddControl(ICanvasControl, ICanvasSection, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasSection section, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . Int32 order Order of the control in the given section AddControl(ICanvasControl, Int32) Adds a new control to your client side page using the default ICanvasSection using a given order Declaration void AddControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the default section AddHeaderControl(ICanvasControl, Int32) Adds a new header control to your client side page with a given order. Used for topic page creation Declaration void AddHeaderControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the given section AddSection(CanvasSectionTemplate, Single) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section AddSection(CanvasSectionTemplate, Single, VariantThemeType, VariantThemeType) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, VariantThemeType zoneEmphasis, VariantThemeType verticalSectionZoneEmphasis = default(VariantThemeType)) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section VariantThemeType zoneEmphasis Zone emphasis (section background) VariantThemeType verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(CanvasSectionTemplate, Single, Int32, Nullable) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, int zoneEmphasis, int? verticalSectionZoneEmphasis = null) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section Int32 zoneEmphasis Zone emphasis (section background) Nullable < Int32 > verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(ICanvasSection) Adds a new section to your client side page Declaration void AddSection(ICanvasSection section) Parameters ICanvasSection section ICanvasSection object describing the section to add AddSection(ICanvasSection, Single) Adds a new section to your client side page with a given order Declaration void AddSection(ICanvasSection section, float order) Parameters ICanvasSection section ICanvasSection object describing the section to add Single order Controls the order of the new section AreCommentsDisabled() Does this page have comments disabled Declaration bool AreCommentsDisabled() Returns Boolean AreCommentsDisabledAsync() Does this page have comments disabled Declaration Task AreCommentsDisabledAsync() Returns Task < Boolean > AvailablePageComponents(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration IEnumerable AvailablePageComponents(string name = null) Parameters String name Name of the web part to retrieve Returns IEnumerable < IPageComponent > List of available IPageComponent AvailablePageComponentsAsync(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration Task> AvailablePageComponentsAsync(string name = null) Parameters String name Name of the web part to retrieve Returns Task < IEnumerable < IPageComponent >> List of available IPageComponent ClearPage() Clears the sections and controls from the page Declaration void ClearPage() DefaultWebPartToWebPartId(DefaultWebPart) Translates a given DefaultWebPart enum to it's corresponding web part id. Non default web parts will be returned as empty string Declaration string DefaultWebPartToWebPartId(DefaultWebPart webPart) Parameters DefaultWebPart webPart DefaultWebPart enum to translate to it's id Returns String The corresponding web part id Delete() Deletes the created page Declaration void Delete() DeleteAsync() Deletes the created page Declaration Task DeleteAsync() Returns Task DemoteNewsArticle() Demotes an client side Article news page as a regular client side page Declaration void DemoteNewsArticle() DemoteNewsArticleAsync() Demotes an client side Article news page as a regular client side page Declaration Task DemoteNewsArticleAsync() Returns Task DisableComments() Disable commenting on this page Declaration void DisableComments() DisableCommentsAsync() Disable commenting on this page Declaration Task DisableCommentsAsync() Returns Task EnableComments() Enable commenting on this page Declaration void EnableComments() EnableCommentsAsync() Enable commenting on this page Declaration Task EnableCommentsAsync() Returns Task GetComments(Expression>[]) Get list item comments Declaration ICommentCollection GetComments(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns ICommentCollection GetCommentsAsync(Expression>[]) Get list item comments Declaration Task GetCommentsAsync(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns Task < ICommentCollection > GetImageWebPart(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration IPageWebPart GetImageWebPart(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns IPageWebPart Configured image web part which can be added to the page GetImageWebPartAsync(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration Task GetImageWebPartAsync(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns Task < IPageWebPart > Configured image web part which can be added to the page GetInlineImage(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration string GetInlineImage(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns String Html snippet to be appended to the text editor content GetInlineImageAsync(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration Task GetInlineImageAsync(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to, when the PnP.Core.Model.SharePoint.Page.EditorType is CK5 then this can be left null String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns Task < String > Html snippet to be appended to the text editor content GetLikedByInformation() Returns information about the likes on this page Declaration ILikedByInformation GetLikedByInformation() Returns ILikedByInformation GetLikedByInformationAsync() Returns information about the likes on this page Declaration Task GetLikedByInformationAsync() Returns Task < ILikedByInformation > GetPageFile(Expression>[]) Gets the file connected to this page Declaration IFile GetPageFile(params Expression>[] expressions) Parameters Expression < Func < IFile , Object >>[] expressions Properties to load for the file Returns IFile The connected IFile GetPageFileAsync(Expression>[]) Gets the file connected to this page Declaration Task GetPageFileAsync(params Expression>[] expressions) Parameters Expression < Func < IFile , Object >>[] expressions Properties to load for the file Returns Task < IFile > The connected IFile GetPageTranslations() Returns the page translation status for a given page Declaration IPageTranslationStatusCollection GetPageTranslations() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations GetPageTranslationsAsync() Returns the page translation status for a given page Declaration Task GetPageTranslationsAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations GetTemplatesFolder() Returns the name of the templates folder, and creates if it doesn't exist. Declaration string GetTemplatesFolder() Returns String GetTemplatesFolderAsync() Returns the name of the templates folder, and creates if it doesn't exist. Declaration Task GetTemplatesFolderAsync() Returns Task < String > InstantiateDefaultWebPart(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration IPageWebPart InstantiateDefaultWebPart(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns IPageWebPart Instantiated web part InstantiateDefaultWebPartAsync(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration Task InstantiateDefaultWebPartAsync(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns Task < IPageWebPart > Instantiated web part Like() Likes a page Declaration void Like() LikeAsync() Likes a page Declaration Task LikeAsync() Returns Task NewTextPart(String) Creates a new text part which can be configured and added to the page Declaration IPageText NewTextPart(string text = null) Parameters String text Optionally provide the text for the text part Returns IPageText The created text part NewWebPart(IPageComponent) Creates a new web part Declaration IPageWebPart NewWebPart(IPageComponent clientSideComponent = null) Parameters IPageComponent clientSideComponent The base component to use for this web part Returns IPageWebPart The created web part PromoteAsHomePage() Sets the current IPage as home page for the current site Declaration void PromoteAsHomePage() PromoteAsHomePageAsync() Sets the current IPage as home page for the current site Declaration Task PromoteAsHomePageAsync() Returns Task PromoteAsNewsArticle() Promotes a regular Article client side page as a news page Declaration void PromoteAsNewsArticle() PromoteAsNewsArticleAsync() Promotes a regular Article client side page as a news page Declaration Task PromoteAsNewsArticleAsync() Returns Task Publish(String) Publishes a client side page Declaration void Publish(string comment = null) Parameters String comment Publishing comment PublishAsync(String) Publishes a client side page Declaration Task PublishAsync(string comment = null) Parameters String comment Publishing comment Returns Task RemovePageHeader() Removes the set page header Declaration void RemovePageHeader() RemoveSchedulePublish() Removes the publication schedule of a client side page Declaration void RemoveSchedulePublish() RemoveSchedulePublishAsync() Removes the publication schedule of a client side page Declaration Task RemoveSchedulePublishAsync() Returns Task Save(String) Saves the page to the pages library Declaration string Save(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplate(String) Saves the page as a template page Declaration string SaveAsTemplate(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplateAsync(String) Saves the page as a template page Declaration Task SaveAsTemplateAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SaveAsync(String) Saves the page to the pages library Declaration Task SaveAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SchedulePublish(DateTime) Schedules the publication of a client side page Declaration void SchedulePublish(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing SchedulePublishAsync(DateTime) Schedules the publication of a client side page Declaration Task SchedulePublishAsync(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing Returns Task SetCustomPageHeader(String, Nullable, Nullable) Sets page header with custom focal point Declaration void SetCustomPageHeader(string serverRelativeImageUrl, double? translateX = null, double? translateY = null) Parameters String serverRelativeImageUrl Server relative page header image url Nullable < System.Double > translateX X focal point for image Nullable < System.Double > translateY Y focal point for image SetDefaultPageHeader() Sets page header back to the default page header Declaration void SetDefaultPageHeader() TranslatePages() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration IPageTranslationStatusCollection TranslatePages() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePages(PageTranslationOptions) Creates page translations for the requested languages Declaration IPageTranslationStatusCollection TranslatePages(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration Task TranslatePagesAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync(PageTranslationOptions) Creates page translations for the requested languages Declaration Task TranslatePagesAsync(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations Unlike() Unlikes a page Declaration void Unlike() UnlikeAsync() Unlikes a page Declaration Task UnlikeAsync() Returns Task WebPartIdToDefaultWebPart(String) Translated a given web part id to a DefaultWebPart enum. Non default web parts will be returned as ThirdParty Declaration DefaultWebPart WebPartIdToDefaultWebPart(string id) Parameters String id Web part id to lookup Returns DefaultWebPart Corresponding DefaultWebPart enum value" + "keywords": "Interface IPage A modern SharePoint Page Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPage Properties Controls List of control on this page Declaration List Controls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > DefaultSection The default section of the client side page Declaration ICanvasSection DefaultSection { get; } Property Value ICanvasSection EditorType Returns the editor that was used to create/update this page Declaration EditorType EditorType { get; } Property Value EditorType EntityId Entity id field for topic pages Declaration string EntityId { get; set; } Property Value String EntityRelations Entity relations field for topic pages Declaration string EntityRelations { get; set; } Property Value String EntityType Entity type field for topic pages Declaration string EntityType { get; set; } Property Value String Folder Folder the page lives in (available after saving the page) Declaration string Folder { get; } Property Value String HeaderControls List of controls on this page's header Declaration List HeaderControls { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasControl > KeepDefaultWebParts When a page of type Home is created you can opt to only keep the default client side web parts by setting this to true. This also is a way to reset your home page back the the stock one. Declaration bool KeepDefaultWebParts { get; set; } Property Value Boolean LayoutType Layout type of the client side page Declaration PageLayoutType LayoutType { get; set; } Property Value PageLayoutType Name The name of this page (available after saving the page) Declaration string Name { get; } Property Value String PageHeader Returns the page header for this page Declaration IPageHeader PageHeader { get; } Property Value IPageHeader PageId ID value of the page (only available when the page was saved) Declaration int? PageId { get; } Property Value Nullable < Int32 > PageListItem ListItem linked to this page Declaration IListItem PageListItem { get; } Property Value IListItem PagesLibrary Pages library Declaration IList PagesLibrary { get; } Property Value IList PageTitle Title of the client side page Declaration string PageTitle { get; set; } Property Value String PnPContext PnPContext to work with Declaration PnPContext PnPContext { get; } Property Value PnPContext RepostDescription Description of the repost page Declaration string RepostDescription { get; set; } Property Value String RepostSourceItemId Id of the SharePoint IListItem connected to the page being reposted Declaration Guid RepostSourceItemId { get; set; } Property Value Guid RepostSourceListId Id of the SharePoint IList containting the page being reposted Declaration Guid RepostSourceListId { get; set; } Property Value Guid RepostSourceSiteId Id of the SharePoint ISite containting the page being reposted Declaration Guid RepostSourceSiteId { get; set; } Property Value Guid RepostSourceUrl Url being reposted using the repost page Declaration string RepostSourceUrl { get; set; } Property Value String RepostSourceWebId Id of the SharePoint IWeb containting the page being reposted Declaration Guid RepostSourceWebId { get; set; } Property Value Guid ScheduledPublishDate Returns the scheduled publish data of a page (only if publish was scheduled) Declaration DateTime? ScheduledPublishDate { get; } Property Value Nullable < DateTime > Sections List of sections on this page Declaration List Sections { get; } Property Value PnP.Core.Model.SharePoint.List < ICanvasSection > SpaceContent Space content field (JSON) for spaces pages Declaration string SpaceContent { get; set; } Property Value String ThumbnailUrl Thumbnail url for the page Declaration string ThumbnailUrl { get; set; } Property Value String Methods AddControl(ICanvasControl) Adds a new control to your client side page using the default ICanvasSection Declaration void AddControl(ICanvasControl control) Parameters ICanvasControl control ICanvasControl to add AddControl(ICanvasControl, ICanvasColumn) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasColumn column) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control AddControl(ICanvasControl, ICanvasColumn, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasColumn column, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasColumn column ICanvasColumn that will hold the control Int32 order Order of the control in the given section AddControl(ICanvasControl, ICanvasSection) Adds a new control to your client side page in the given section Declaration void AddControl(ICanvasControl control, ICanvasSection section) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . AddControl(ICanvasControl, ICanvasSection, Int32) Adds a new control to your client side page in the given section with a given order Declaration void AddControl(ICanvasControl control, ICanvasSection section, int order) Parameters ICanvasControl control ICanvasControl to add ICanvasSection section ICanvasSection that will hold the control. Control will end up in the DefaultColumn . Int32 order Order of the control in the given section AddControl(ICanvasControl, Int32) Adds a new control to your client side page using the default ICanvasSection using a given order Declaration void AddControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the default section AddHeaderControl(ICanvasControl, Int32) Adds a new header control to your client side page with a given order. Used for topic page creation Declaration void AddHeaderControl(ICanvasControl control, int order) Parameters ICanvasControl control ICanvasControl to add Int32 order Order of the control in the given section AddSection(CanvasSectionTemplate, Single) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section AddSection(CanvasSectionTemplate, Single, VariantThemeType, VariantThemeType) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, VariantThemeType zoneEmphasis, VariantThemeType verticalSectionZoneEmphasis = default(VariantThemeType)) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section VariantThemeType zoneEmphasis Zone emphasis (section background) VariantThemeType verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(CanvasSectionTemplate, Single, Int32, Nullable) Adds a new section to your client side page Declaration void AddSection(CanvasSectionTemplate sectionTemplate, float order, int zoneEmphasis, int? verticalSectionZoneEmphasis = null) Parameters CanvasSectionTemplate sectionTemplate The CanvasSectionTemplate type of the section Single order Controls the order of the new section Int32 zoneEmphasis Zone emphasis (section background) Nullable < Int32 > verticalSectionZoneEmphasis Vertical Section Zone emphasis (section background) AddSection(ICanvasSection) Adds a new section to your client side page Declaration void AddSection(ICanvasSection section) Parameters ICanvasSection section ICanvasSection object describing the section to add AddSection(ICanvasSection, Single) Adds a new section to your client side page with a given order Declaration void AddSection(ICanvasSection section, float order) Parameters ICanvasSection section ICanvasSection object describing the section to add Single order Controls the order of the new section AreCommentsDisabled() Does this page have comments disabled Declaration bool AreCommentsDisabled() Returns Boolean AreCommentsDisabledAsync() Does this page have comments disabled Declaration Task AreCommentsDisabledAsync() Returns Task < Boolean > AvailablePageComponents(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration IEnumerable AvailablePageComponents(string name = null) Parameters String name Name of the web part to retrieve Returns IEnumerable < IPageComponent > List of available IPageComponent AvailablePageComponentsAsync(String) Gets a list of available client side web parts to use, optionally filtered by a given name Declaration Task> AvailablePageComponentsAsync(string name = null) Parameters String name Name of the web part to retrieve Returns Task < IEnumerable < IPageComponent >> List of available IPageComponent ClearPage() Clears the sections and controls from the page Declaration void ClearPage() DefaultWebPartToWebPartId(DefaultWebPart) Translates a given DefaultWebPart enum to it's corresponding web part id. Non default web parts will be returned as empty string Declaration string DefaultWebPartToWebPartId(DefaultWebPart webPart) Parameters DefaultWebPart webPart DefaultWebPart enum to translate to it's id Returns String The corresponding web part id Delete() Deletes the created page Declaration void Delete() DeleteAsync() Deletes the created page Declaration Task DeleteAsync() Returns Task DemoteNewsArticle() Demotes an client side Article news page as a regular client side page Declaration void DemoteNewsArticle() DemoteNewsArticleAsync() Demotes an client side Article news page as a regular client side page Declaration Task DemoteNewsArticleAsync() Returns Task DisableComments() Disable commenting on this page Declaration void DisableComments() DisableCommentsAsync() Disable commenting on this page Declaration Task DisableCommentsAsync() Returns Task EnableComments() Enable commenting on this page Declaration void EnableComments() EnableCommentsAsync() Enable commenting on this page Declaration Task EnableCommentsAsync() Returns Task GetComments(Expression>[]) Get list item comments Declaration ICommentCollection GetComments(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns ICommentCollection GetCommentsAsync(Expression>[]) Get list item comments Declaration Task GetCommentsAsync(params Expression>[] selectors) Parameters Expression < Func < IComment , Object >>[] selectors The expressions declaring the fields to select Returns Task < ICommentCollection > GetImageWebPart(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration IPageWebPart GetImageWebPart(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns IPageWebPart Configured image web part which can be added to the page GetImageWebPartAsync(String, PageImageOptions) Prepares an Image web part for adding to a page Declaration Task GetImageWebPartAsync(string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters String serverRelativeUrl Server relative url of the image to show in the image web part PageImageOptions imageOptions Options to configure the image when being added Returns Task < IPageWebPart > Configured image web part which can be added to the page GetInlineImage(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration string GetInlineImage(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns String Html snippet to be appended to the text editor content GetInlineImageAsync(IPageText, String, PageImageOptions) Prepares an inline image for adding to text by adding the needed image web part and returning the HTML snippet that needs to be appended to the text editor content Declaration Task GetInlineImageAsync(IPageText textEditorInstance, string serverRelativeUrl, PageImageOptions imageOptions = null) Parameters IPageText textEditorInstance Text editor instance to add the inline image to, when the PnP.Core.Model.SharePoint.Page.EditorType is CK5 then this can be left null String serverRelativeUrl Server relative url of the image to add inline PageImageOptions imageOptions Options to configure the inline image when being added Returns Task < String > Html snippet to be appended to the text editor content GetLikedByInformation() Returns information about the likes on this page Declaration ILikedByInformation GetLikedByInformation() Returns ILikedByInformation GetLikedByInformationAsync() Returns information about the likes on this page Declaration Task GetLikedByInformationAsync() Returns Task < ILikedByInformation > GetPageFile(Expression>[]) Gets the file connected to this page Declaration IFile GetPageFile(params Expression>[] expressions) Parameters Expression < Func < IFile , Object >>[] expressions Properties to load for the file Returns IFile The connected IFile GetPageFileAsync(Expression>[]) Gets the file connected to this page Declaration Task GetPageFileAsync(params Expression>[] expressions) Parameters Expression < Func < IFile , Object >>[] expressions Properties to load for the file Returns Task < IFile > The connected IFile GetPageTranslations() Returns the page translation status for a given page Declaration IPageTranslationStatusCollection GetPageTranslations() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations GetPageTranslationsAsync() Returns the page translation status for a given page Declaration Task GetPageTranslationsAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations GetTemplatesFolder() Returns the name of the templates folder, and creates if it doesn't exist. Declaration string GetTemplatesFolder() Returns String GetTemplatesFolderAsync() Returns the name of the templates folder, and creates if it doesn't exist. Declaration Task GetTemplatesFolderAsync() Returns Task < String > InstantiateDefaultWebPart(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration IPageWebPart InstantiateDefaultWebPart(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns IPageWebPart Instantiated web part InstantiateDefaultWebPartAsync(DefaultWebPart) Instantiates a new web part with default data and returns it Declaration Task InstantiateDefaultWebPartAsync(DefaultWebPart webPart) Parameters DefaultWebPart webPart Default web part to instantiate Returns Task < IPageWebPart > Instantiated web part Like() Likes a page Declaration void Like() LikeAsync() Likes a page Declaration Task LikeAsync() Returns Task NewTextPart(String) Creates a new text part which can be configured and added to the page Declaration IPageText NewTextPart(string text = null) Parameters String text Optionally provide the text for the text part Returns IPageText The created text part NewWebPart(IPageComponent) Creates a new web part Declaration IPageWebPart NewWebPart(IPageComponent clientSideComponent = null) Parameters IPageComponent clientSideComponent The base component to use for this web part Returns IPageWebPart The created web part PromoteAsHomePage() Sets the current IPage as home page for the current site Declaration void PromoteAsHomePage() PromoteAsHomePageAsync() Sets the current IPage as home page for the current site Declaration Task PromoteAsHomePageAsync() Returns Task PromoteAsNewsArticle() Promotes a regular Article client side page as a news page Declaration void PromoteAsNewsArticle() PromoteAsNewsArticleAsync() Promotes a regular Article client side page as a news page Declaration Task PromoteAsNewsArticleAsync() Returns Task Publish(String) Publishes a client side page Declaration void Publish(string comment = null) Parameters String comment Publishing comment PublishAsync(String) Publishes a client side page Declaration Task PublishAsync(string comment = null) Parameters String comment Publishing comment Returns Task RemovePageHeader() Removes the set page header Declaration void RemovePageHeader() RemoveSchedulePublish() Removes the publication schedule of a client side page Declaration void RemoveSchedulePublish() RemoveSchedulePublishAsync() Removes the publication schedule of a client side page Declaration Task RemoveSchedulePublishAsync() Returns Task Save(String) Saves the page to the pages library Declaration string Save(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplate(String) Saves the page as a template page Declaration string SaveAsTemplate(string pageName = null) Parameters String pageName Page name to use Returns String The name of the saved page SaveAsTemplateAsync(String) Saves the page as a template page Declaration Task SaveAsTemplateAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SaveAsync(String) Saves the page to the pages library Declaration Task SaveAsync(string pageName = null) Parameters String pageName Page name to use Returns Task < String > The name of the saved page SchedulePublish(DateTime) Schedules the publication of a client side page Declaration void SchedulePublish(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing SchedulePublishAsync(DateTime) Schedules the publication of a client side page Declaration Task SchedulePublishAsync(DateTime publishDate) Parameters DateTime publishDate Date when the page needs to be publishing Returns Task SetCustomPageHeader(String, Nullable, Nullable) Sets page header with custom focal point Declaration void SetCustomPageHeader(string serverRelativeImageUrl, double? translateX = null, double? translateY = null) Parameters String serverRelativeImageUrl Server relative page header image url Nullable < Double > translateX X focal point for image Nullable < Double > translateY Y focal point for image SetDefaultPageHeader() Sets page header back to the default page header Declaration void SetDefaultPageHeader() TranslatePages() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration IPageTranslationStatusCollection TranslatePages() Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePages(PageTranslationOptions) Creates page translations for the requested languages Declaration IPageTranslationStatusCollection TranslatePages(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns IPageTranslationStatusCollection IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync() Creates page translations for all the languages defined as multi-lingual languages in the site Declaration Task TranslatePagesAsync() Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations TranslatePagesAsync(PageTranslationOptions) Creates page translations for the requested languages Declaration Task TranslatePagesAsync(PageTranslationOptions pageTranslationOptions) Parameters PageTranslationOptions pageTranslationOptions Options describing the languages in which a translation needs to be created Returns Task < IPageTranslationStatusCollection > IPageTranslationStatusCollection list containing information about this page's translations Unlike() Unlikes a page Declaration void Unlike() UnlikeAsync() Unlikes a page Declaration Task UnlikeAsync() Returns Task WebPartIdToDefaultWebPart(String) Translated a given web part id to a DefaultWebPart enum. Non default web parts will be returned as ThirdParty Declaration DefaultWebPart WebPartIdToDefaultWebPart(string id) Parameters String id Web part id to lookup Returns DefaultWebPart Corresponding DefaultWebPart enum value" }, "api/PnP.Core.Model.SharePoint.IPageComponent.html": { "href": "api/PnP.Core.Model.SharePoint.IPageComponent.html", @@ -2067,7 +2067,7 @@ "api/PnP.Core.Model.SharePoint.IPageHeader.html": { "href": "api/PnP.Core.Model.SharePoint.IPageHeader.html", "title": "Interface IPageHeader | PnP Core SDK", - "keywords": "Interface IPageHeader Class that implements the modern page header Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPageHeader Properties AlternativeText Alternative text for the header image Declaration string AlternativeText { get; set; } Property Value String AuthorByLine Page author byline Declaration string AuthorByLine { get; set; } Property Value String AuthorByLineId Id of the page author Declaration int AuthorByLineId { get; set; } Property Value Int32 Authors Page author(s) to be displayed Declaration string Authors { get; set; } Property Value String ImageServerRelativeUrl Server relative link to page header image, set to null for default header image. Note: image needs to reside in the current site Declaration string ImageServerRelativeUrl { get; set; } Property Value String LayoutType Type of layout used inside the header Declaration PageHeaderLayoutType LayoutType { get; set; } Property Value PageHeaderLayoutType ShowPublishDate Show the page publication date in the title region Declaration bool ShowPublishDate { get; set; } Property Value Boolean ShowTopicHeader Show the topic header in the title region Declaration bool ShowTopicHeader { get; set; } Property Value Boolean TextAlignment Alignment of the title in the header Declaration PageHeaderTitleAlignment TextAlignment { get; set; } Property Value PageHeaderTitleAlignment TopicHeader The topic header text to show if ShowTopicHeader is set to true Declaration string TopicHeader { get; set; } Property Value String TranslateX Image focal point X coordinate Declaration double? TranslateX { get; set; } Property Value Nullable < System.Double > TranslateY Image focal point Y coordinate Declaration double? TranslateY { get; set; } Property Value Nullable < System.Double > Type Returns the type of header Declaration PageHeaderType Type { get; } Property Value PageHeaderType" + "keywords": "Interface IPageHeader Class that implements the modern page header Namespace : PnP.Core.Model.SharePoint Assembly : PnP.Core.dll Syntax public interface IPageHeader Properties AlternativeText Alternative text for the header image Declaration string AlternativeText { get; set; } Property Value String AuthorByLine Page author byline Declaration string AuthorByLine { get; set; } Property Value String AuthorByLineId Id of the page author Declaration int AuthorByLineId { get; set; } Property Value Int32 Authors Page author(s) to be displayed Declaration string Authors { get; set; } Property Value String ImageServerRelativeUrl Server relative link to page header image, set to null for default header image. Note: image needs to reside in the current site Declaration string ImageServerRelativeUrl { get; set; } Property Value String LayoutType Type of layout used inside the header Declaration PageHeaderLayoutType LayoutType { get; set; } Property Value PageHeaderLayoutType ShowPublishDate Show the page publication date in the title region Declaration bool ShowPublishDate { get; set; } Property Value Boolean ShowTopicHeader Show the topic header in the title region Declaration bool ShowTopicHeader { get; set; } Property Value Boolean TextAlignment Alignment of the title in the header Declaration PageHeaderTitleAlignment TextAlignment { get; set; } Property Value PageHeaderTitleAlignment TopicHeader The topic header text to show if ShowTopicHeader is set to true Declaration string TopicHeader { get; set; } Property Value String TranslateX Image focal point X coordinate Declaration double? TranslateX { get; set; } Property Value Nullable < Double > TranslateY Image focal point Y coordinate Declaration double? TranslateY { get; set; } Property Value Nullable < Double > Type Returns the type of header Declaration PageHeaderType Type { get; } Property Value PageHeaderType" }, "api/PnP.Core.Model.SharePoint.IPageText.html": { "href": "api/PnP.Core.Model.SharePoint.IPageText.html", @@ -2772,7 +2772,7 @@ "api/PnP.Core.Model.Teams.EventCoordinateOptions.html": { "href": "api/PnP.Core.Model.Teams.EventCoordinateOptions.html", "title": "Class EventCoordinateOptions | PnP Core SDK", - "keywords": "Class EventCoordinateOptions Options that can be set when creating a coordinate location for a meeting request Inheritance Object EventCoordinateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventCoordinateOptions : object Properties Accuracy Accuracy Declaration public double Accuracy { get; set; } Property Value System.Double Altitude Altitude Declaration public double Altitude { get; set; } Property Value System.Double AltitudeAccuracy Altitude Accuracy Declaration public double AltitudeAccuracy { get; set; } Property Value System.Double Latitude Latitude Declaration public double Latitude { get; set; } Property Value System.Double Longitude Longitude Declaration public double Longitude { get; set; } Property Value System.Double" + "keywords": "Class EventCoordinateOptions Options that can be set when creating a coordinate location for a meeting request Inheritance Object EventCoordinateOptions Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public class EventCoordinateOptions : object Properties Accuracy Accuracy Declaration public double Accuracy { get; set; } Property Value Double Altitude Altitude Declaration public double Altitude { get; set; } Property Value Double AltitudeAccuracy Altitude Accuracy Declaration public double AltitudeAccuracy { get; set; } Property Value Double Latitude Latitude Declaration public double Latitude { get; set; } Property Value Double Longitude Longitude Declaration public double Longitude { get; set; } Property Value Double" }, "api/PnP.Core.Model.Teams.EventCreateOptions.html": { "href": "api/PnP.Core.Model.Teams.EventCreateOptions.html", @@ -2932,7 +2932,7 @@ "api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html": { "href": "api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html", "title": "Interface IGraphOutlookGeoCoordinates | PnP Core SDK", - "keywords": "Interface IGraphOutlookGeoCoordinates The geographic coordinates, elevation, and their degree of accuracy for a physical location. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public interface IGraphOutlookGeoCoordinates : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Properties Accuracy The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters. Declaration double Accuracy { get; } Property Value System.Double Altitude The altitude of the location. Declaration double Altitude { get; } Property Value System.Double AltitudeAccuracy The accuracy of the altitude. Declaration double AltitudeAccuracy { get; set; } Property Value System.Double Latitude The latitude of the location. Declaration double Latitude { get; set; } Property Value System.Double Longitude The longitude of the location. Declaration double Longitude { get; set; } Property Value System.Double Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" + "keywords": "Interface IGraphOutlookGeoCoordinates The geographic coordinates, elevation, and their degree of accuracy for a physical location. Inherited Members IDataModel.Requested IDataModel.HasValue(String) IDataModel.HasChanged(String) IDataModel.IsPropertyAvailable(Expression>) IDataModel.ArePropertiesAvailable(Expression>[]) IDataModel.EnsureProperties(Expression>[]) IDataModel.EnsurePropertiesAsync(Expression>[]) IDataModel.ExecuteRequestAsync(ApiRequest) IDataModel.ExecuteRequest(ApiRequest) IDataModel.ExecuteRequestBatchAsync(ApiRequest) IDataModel.ExecuteRequestBatch(ApiRequest) IDataModel.ExecuteRequestBatchAsync(Batch, ApiRequest) IDataModel.ExecuteRequestBatch(Batch, ApiRequest) IDataModelParent.Parent IDataModelWithContext.PnPContext Namespace : PnP.Core.Model.Teams Assembly : PnP.Core.dll Syntax public interface IGraphOutlookGeoCoordinates : IDataModel, IDataModelParent, IDataModelWithContext, ISupportModules Properties Accuracy The accuracy of the latitude and longitude. As an example, the accuracy can be measured in meters, such as the latitude and longitude are accurate to within 50 meters. Declaration double Accuracy { get; } Property Value Double Altitude The altitude of the location. Declaration double Altitude { get; } Property Value Double AltitudeAccuracy The accuracy of the altitude. Declaration double AltitudeAccuracy { get; set; } Property Value Double Latitude The latitude of the location. Declaration double Latitude { get; set; } Property Value Double Longitude The longitude of the location. Declaration double Longitude { get; set; } Property Value Double Extension Methods RequestModuleExtensions.WithHeaders(ISupportModules, Dictionary, Action>)" }, "api/PnP.Core.Model.Teams.IGraphPatternedRecurrence.html": { "href": "api/PnP.Core.Model.Teams.IGraphPatternedRecurrence.html", diff --git a/manifest.json b/manifest.json index cec04826f2..58b2930213 100644 --- a/manifest.json +++ b/manifest.json @@ -3546,7 +3546,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldLocationValue.html", - "hash": "MFDQsxztbnRIq7QB3wjgGDnSME6Wtu1OHzv3cJKT2xM=" + "hash": "GprZH0hVpFI6XSfanvYa7jzrmUXrqUwIzM1qzcAnNA4=" } }, "is_incremental": false, @@ -3594,7 +3594,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.FieldNumberOptions.html", - "hash": "lUYBN3DpEU7tkbHloAaXLNspzDx3UuGtC9BmJssCxjc=" + "hash": "A7vgSWI7UAyvQ3RqtVUW4PSzZOqER+8lWzo3CWqDxog=" } }, "is_incremental": false, @@ -4362,7 +4362,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IField.html", - "hash": "LxIZ5J/2voS91BMgdaPifzCtlGWha1spZBV5yz8/z+Q=" + "hash": "zLFNUNUA34AxNuiUnX22RXrVh063f/wFpBsI8OEXLCA=" } }, "is_incremental": false, @@ -4410,7 +4410,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IFieldLocationValue.html", - "hash": "CoQ7rzls7wTZ4JiaXjTv14FBxaL3ETxV2vm4XMjuE/4=" + "hash": "HcN986UEvOpM4mBJiJ4QIMHnAII2sncw136SWJCYfYY=" } }, "is_incremental": false, @@ -4662,7 +4662,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IHeaderOptions.html", - "hash": "FFDCUxwLAdxyl83tnUx5hvnLu2ywGbFvczN2pD1h13U=" + "hash": "jMBy9pX3tgRJvsyws0dncGDg5oynihaGKDDxfoBUaMc=" } }, "is_incremental": false, @@ -4890,7 +4890,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IPage.html", - "hash": "bgIsp8D0HUOnWff+NV5JcpcK3rMVNnwlu9dwNBymT3U=" + "hash": "9Txu3o0Iw0tXv2oDGeclcFXPOjz2L4u7WS5Iu5X3Mo4=" } }, "is_incremental": false, @@ -4914,7 +4914,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.SharePoint.IPageHeader.html", - "hash": "4rMDjbwKnH4f/Amwv4WxbBs0DNkymk+/wOzCqaoL2IM=" + "hash": "shjOVoknXlpK09fIyZ9iOP7AHhMjRQNrCs9NnZLPVH4=" } }, "is_incremental": false, @@ -6630,7 +6630,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.EventCoordinateOptions.html", - "hash": "r9ZfKeKb953XQW+oYX93+ZgcId0JQPvgnJUUm0zB2ao=" + "hash": "ieuMNbuBuWM9EMy++bnpQNQ+YMqX2OFfGP5qYEGOEqo=" } }, "is_incremental": false, @@ -7002,7 +7002,7 @@ "output": { ".html": { "relative_path": "api/PnP.Core.Model.Teams.IGraphOutlookGeoCoordinates.html", - "hash": "SQXr5jeSQ3FiBNseDDITvGPFQi+hnRe22o1CvziaHWM=" + "hash": "/erLm/sIdiKbUXxsFpQrxmjzYjHEQcHZst1cZ/hasmM=" } }, "is_incremental": false,
- System.Double + Double