Interface IFieldCollection

Public interface to define a collection of Field objects of SharePoint Online

Inherited Members

IDataModelCollectionLoad<IField>.LoadAsync(Expression<Func<IField, Object>>[])

IDataModelCollectionLoad<IField>.LoadBatchAsync(Batch, Expression<Func<IField, Object>>[])

IDataModelParent.Parent

IDataModelWithContext.PnPContext

IRequestableCollection.Requested

IRequestableCollection.Length

IRequestableCollection.RequestedItems

IRequestableCollection.Clear()

IDataModelCollectionDeleteByGuidId.DeleteById(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatch(Batch, Guid)

IDataModelCollectionDeleteByGuidId.DeleteByIdBatchAsync(Batch, Guid)

Namespace: PnP.Core.Model.SharePoint

Assembly: PnP.Core.dll

Syntax

public interface IFieldCollection : IDataModelCollectionLoad<IField>, IDataModelCollection<IField>, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionDeleteByGuidId, ISupportModules<IFieldCollection>

Methods

AddBoolean(String, FieldBooleanOptions)

Adds a new Boolean field to the collection

Declaration

IField AddBoolean(string title, FieldBooleanOptions options)

Parameters

System.String title The title of the field

FieldBooleanOptions options The specific options for field creation

Returns

IField The added field

AddBooleanAsync(String, FieldBooleanOptions)

Adds a new Boolean field to the collection

Declaration

Task<IField> AddBooleanAsync(string title, FieldBooleanOptions options)

Parameters

System.String title The title of the field

FieldBooleanOptions options The specific options for field creation

Returns

Task<IField> The added field

AddBooleanBatch(Batch, String, FieldBooleanOptions)

Adds a new Boolean field to the collection

Declaration

IField AddBooleanBatch(Batch batch, string title, FieldBooleanOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldBooleanOptions options The specific options for field creation

Returns

IField The added field

AddBooleanBatch(String, FieldBooleanOptions)

Adds a new Boolean field to the collection

Declaration

IField AddBooleanBatch(string title, FieldBooleanOptions options)

Parameters

System.String title The title of the field

FieldBooleanOptions options The specific options for field creation

Returns

IField The added field

AddBooleanBatchAsync(Batch, String, FieldBooleanOptions)

Adds a new Boolean field to the collection

Declaration

Task<IField> AddBooleanBatchAsync(Batch batch, string title, FieldBooleanOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldBooleanOptions options The specific options for field creation

Returns

Task<IField> The added field

AddBooleanBatchAsync(String, FieldBooleanOptions)

Adds a new Boolean field to the collection

Declaration

Task<IField> AddBooleanBatchAsync(string title, FieldBooleanOptions options)

Parameters

System.String title The title of the field

FieldBooleanOptions options The specific options for field creation

Returns

Task<IField> The added field

AddCalculated(String, FieldCalculatedOptions)

Adds a new Calculated field to the collection

Declaration

IField AddCalculated(string title, FieldCalculatedOptions options)

Parameters

System.String title The title of the field

FieldCalculatedOptions options The specific options for field creation

Returns

IField The added field

AddCalculatedAsync(String, FieldCalculatedOptions)

Adds a new Calculated field to the collection

Declaration

Task<IField> AddCalculatedAsync(string title, FieldCalculatedOptions options)

Parameters

System.String title The title of the field

FieldCalculatedOptions options The specific options for field creation

Returns

Task<IField> The added field

AddCalculatedBatch(Batch, String, FieldCalculatedOptions)

Adds a new Calculated field to the collection

Declaration

IField AddCalculatedBatch(Batch batch, string title, FieldCalculatedOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldCalculatedOptions options The specific options for field creation

Returns

IField The added field

AddCalculatedBatch(String, FieldCalculatedOptions)

Adds a new Calculated field to the collection

Declaration

IField AddCalculatedBatch(string title, FieldCalculatedOptions options)

Parameters

System.String title The title of the field

FieldCalculatedOptions options The specific options for field creation

Returns

IField The added field

AddCalculatedBatchAsync(Batch, String, FieldCalculatedOptions)

Adds a new Calculated field to the collection

Declaration

Task<IField> AddCalculatedBatchAsync(Batch batch, string title, FieldCalculatedOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldCalculatedOptions options The specific options for field creation

Returns

Task<IField> The added field

AddCalculatedBatchAsync(String, FieldCalculatedOptions)

Adds a new Calculated field to the collection

Declaration

Task<IField> AddCalculatedBatchAsync(string title, FieldCalculatedOptions options)

Parameters

System.String title The title of the field

FieldCalculatedOptions options The specific options for field creation

Returns

Task<IField> The added field

AddChoice(String, FieldChoiceOptions)

Adds a new Choice field to the collection

Declaration

IField AddChoice(string title, FieldChoiceOptions options)

Parameters

System.String title The title of the field

FieldChoiceOptions options The specific options for field creation

Returns

IField The added field

AddChoiceAsync(String, FieldChoiceOptions)

Adds a new Choice field to the collection

Declaration

Task<IField> AddChoiceAsync(string title, FieldChoiceOptions options)

Parameters

System.String title The title of the field

FieldChoiceOptions options The specific options for field creation

Returns

Task<IField> The added field

AddChoiceBatch(Batch, String, FieldChoiceOptions)

Adds a new Choice field to the collection

Declaration

IField AddChoiceBatch(Batch batch, string title, FieldChoiceOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldChoiceOptions options The specific options for field creation

Returns

IField The added field

AddChoiceBatch(String, FieldChoiceOptions)

Adds a new Choice field to the collection

Declaration

IField AddChoiceBatch(string title, FieldChoiceOptions options)

Parameters

System.String title The title of the field

FieldChoiceOptions options The specific options for field creation

Returns

IField The added field

AddChoiceBatchAsync(Batch, String, FieldChoiceOptions)

Adds a new Choice field to the collection

Declaration

Task<IField> AddChoiceBatchAsync(Batch batch, string title, FieldChoiceOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldChoiceOptions options The specific options for field creation

Returns

Task<IField> The added field

AddChoiceBatchAsync(String, FieldChoiceOptions)

Adds a new Choice field to the collection

Declaration

Task<IField> AddChoiceBatchAsync(string title, FieldChoiceOptions options)

Parameters

System.String title The title of the field

FieldChoiceOptions options The specific options for field creation

Returns

Task<IField> The added field

AddChoiceMulti(String, FieldChoiceMultiOptions)

Adds a new MultiChoice field to the collection

Declaration

IField AddChoiceMulti(string title, FieldChoiceMultiOptions options)

Parameters

System.String title The title of the field

FieldChoiceMultiOptions options The specific options for field creation

Returns

IField The added field

AddChoiceMultiAsync(String, FieldChoiceMultiOptions)

Adds a new MultiChoice field to the collection

Declaration

Task<IField> AddChoiceMultiAsync(string title, FieldChoiceMultiOptions options)

Parameters

System.String title The title of the field

FieldChoiceMultiOptions options The specific options for field creation

Returns

Task<IField> The added field

AddChoiceMultiBatch(Batch, String, FieldChoiceMultiOptions)

Adds a new MultiChoice field to the collection

Declaration

IField AddChoiceMultiBatch(Batch batch, string title, FieldChoiceMultiOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldChoiceMultiOptions options The specific options for field creation

Returns

IField The added field

AddChoiceMultiBatch(String, FieldChoiceMultiOptions)

Adds a new MultiChoice field to the collection

Declaration

IField AddChoiceMultiBatch(string title, FieldChoiceMultiOptions options)

Parameters

System.String title The title of the field

FieldChoiceMultiOptions options The specific options for field creation

Returns

IField The added field

AddChoiceMultiBatchAsync(Batch, String, FieldChoiceMultiOptions)

Adds a new MultiChoice field to the collection

Declaration

Task<IField> AddChoiceMultiBatchAsync(Batch batch, string title, FieldChoiceMultiOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldChoiceMultiOptions options The specific options for field creation

Returns

Task<IField> The added field

AddChoiceMultiBatchAsync(String, FieldChoiceMultiOptions)

Adds a new MultiChoice field to the collection

Declaration

Task<IField> AddChoiceMultiBatchAsync(string title, FieldChoiceMultiOptions options)

Parameters

System.String title The title of the field

FieldChoiceMultiOptions options The specific options for field creation

Returns

Task<IField> The added field

AddCurrency(String, FieldCurrencyOptions)

Adds a new Currency field to the collection

Declaration

IField AddCurrency(string title, FieldCurrencyOptions options)

Parameters

System.String title The title of the field

FieldCurrencyOptions options The specific options for field creation

Returns

IField The added field

AddCurrencyAsync(String, FieldCurrencyOptions)

Adds a new Currency field to the collection

Declaration

Task<IField> AddCurrencyAsync(string title, FieldCurrencyOptions options)

Parameters

System.String title The title of the field

FieldCurrencyOptions options The specific options for field creation

Returns

Task<IField> The added field

AddCurrencyBatch(Batch, String, FieldCurrencyOptions)

Adds a new Currency field to the collection

Declaration

IField AddCurrencyBatch(Batch batch, string title, FieldCurrencyOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldCurrencyOptions options The specific options for field creation

Returns

IField The added field

AddCurrencyBatch(String, FieldCurrencyOptions)

Adds a new Currency field to the collection

Declaration

IField AddCurrencyBatch(string title, FieldCurrencyOptions options)

Parameters

System.String title The title of the field

FieldCurrencyOptions options The specific options for field creation

Returns

IField The added field

AddCurrencyBatchAsync(Batch, String, FieldCurrencyOptions)

Adds a new Currency field to the collection

Declaration

Task<IField> AddCurrencyBatchAsync(Batch batch, string title, FieldCurrencyOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldCurrencyOptions options The specific options for field creation

Returns

Task<IField> The added field

AddCurrencyBatchAsync(String, FieldCurrencyOptions)

Adds a new Currency field to the collection

Declaration

Task<IField> AddCurrencyBatchAsync(string title, FieldCurrencyOptions options)

Parameters

System.String title The title of the field

FieldCurrencyOptions options The specific options for field creation

Returns

Task<IField> The added field

AddDateTime(String, FieldDateTimeOptions)

Adds a new DateTime field to the collection

Declaration

IField AddDateTime(string title, FieldDateTimeOptions options)

Parameters

System.String title The title of the field

FieldDateTimeOptions options The specific options for field creation

Returns

IField The added field

AddDateTimeAsync(String, FieldDateTimeOptions)

Adds a new DateTime field to the collection

Declaration

Task<IField> AddDateTimeAsync(string title, FieldDateTimeOptions options)

Parameters

System.String title The title of the field

FieldDateTimeOptions options The specific options for field creation

Returns

Task<IField> The added field

AddDateTimeBatch(Batch, String, FieldDateTimeOptions)

Adds a new DateTime field to the collection

Declaration

IField AddDateTimeBatch(Batch batch, string title, FieldDateTimeOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldDateTimeOptions options The specific options for field creation

Returns

IField The added field

AddDateTimeBatch(String, FieldDateTimeOptions)

Adds a new DateTime field to the collection

Declaration

IField AddDateTimeBatch(string title, FieldDateTimeOptions options)

Parameters

System.String title The title of the field

FieldDateTimeOptions options The specific options for field creation

Returns

IField The added field

AddDateTimeBatchAsync(Batch, String, FieldDateTimeOptions)

Adds a new DateTime field to the collection

Declaration

Task<IField> AddDateTimeBatchAsync(Batch batch, string title, FieldDateTimeOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldDateTimeOptions options The specific options for field creation

Returns

Task<IField> The added field

AddDateTimeBatchAsync(String, FieldDateTimeOptions)

Adds a new DateTime field to the collection

Declaration

Task<IField> AddDateTimeBatchAsync(string title, FieldDateTimeOptions options)

Parameters

System.String title The title of the field

FieldDateTimeOptions options The specific options for field creation

Returns

Task<IField> The added field

AddFieldAsXml(String, Boolean, AddFieldOptionsFlags)

Adds a new field from its XML schema

Declaration

IField AddFieldAsXml(string schemaXml, bool addToDefaultView = false, AddFieldOptionsFlags options = default(AddFieldOptionsFlags))

Parameters

System.String schemaXml A Collaborative Application Markup Language (CAML) string that contains the schema. It must not be a null reference(Nothing in Visual Basic). It must not be empty.It must be a valid Collaborative Application Markup Language(CAML) string according to the schema specified in [MS-WSSFO2], section 2.2.9.3.3.1.

System.Boolean addToDefaultView Specifies to add the field to the default list view. true if the field is added to the default list view; otherwise, false.

AddFieldOptionsFlags options An AddFieldOptionsFlags value that specifies the field options.

Returns

IField The added field

AddFieldAsXmlAsync(String, Boolean, AddFieldOptionsFlags)

Adds a new field from its XML schema

Declaration

Task<IField> AddFieldAsXmlAsync(string schemaXml, bool addToDefaultView = false, AddFieldOptionsFlags options = default(AddFieldOptionsFlags))

Parameters

System.String schemaXml A Collaborative Application Markup Language (CAML) string that contains the schema. It must not be a null reference(Nothing in Visual Basic). It must not be empty.It must be a valid Collaborative Application Markup Language(CAML) string according to the schema specified in [MS-WSSFO2], section 2.2.9.3.3.1.

System.Boolean addToDefaultView Specifies to add the field to the default list view. true if the field is added to the default list view; otherwise, false.

AddFieldOptionsFlags options An AddFieldOptionsFlags value that specifies the field options.

Returns

Task<IField> The added field

AddFieldAsXmlBatch(Batch, String, Boolean, AddFieldOptionsFlags)

Adds a new field from its XML schema

Declaration

IField AddFieldAsXmlBatch(Batch batch, string schemaXml, bool addToDefaultView = false, AddFieldOptionsFlags options = default(AddFieldOptionsFlags))

Parameters

Batch batch Batch to use

System.String schemaXml A Collaborative Application Markup Language (CAML) string that contains the schema. It must not be a null reference(Nothing in Visual Basic). It must not be empty.It must be a valid Collaborative Application Markup Language(CAML) string according to the schema specified in [MS-WSSFO2], section 2.2.9.3.3.1.

System.Boolean addToDefaultView Specifies to add the field to the default list view. true if the field is added to the default list view; otherwise, false.

AddFieldOptionsFlags options An AddFieldOptionsFlags value that specifies the field options.

Returns

IField The added field

AddFieldAsXmlBatch(String, Boolean, AddFieldOptionsFlags)

Adds a new field from its XML schema

Declaration

IField AddFieldAsXmlBatch(string schemaXml, bool addToDefaultView = false, AddFieldOptionsFlags options = default(AddFieldOptionsFlags))

Parameters

System.String schemaXml A Collaborative Application Markup Language (CAML) string that contains the schema. It must not be a null reference(Nothing in Visual Basic). It must not be empty.It must be a valid Collaborative Application Markup Language(CAML) string according to the schema specified in [MS-WSSFO2], section 2.2.9.3.3.1.

System.Boolean addToDefaultView Specifies to add the field to the default list view. true if the field is added to the default list view; otherwise, false.

AddFieldOptionsFlags options An AddFieldOptionsFlags value that specifies the field options.

Returns

IField The added field

AddFieldAsXmlBatchAsync(Batch, String, Boolean, AddFieldOptionsFlags)

Adds a new field from its XML schema

Declaration

Task<IField> AddFieldAsXmlBatchAsync(Batch batch, string schemaXml, bool addToDefaultView = false, AddFieldOptionsFlags options = default(AddFieldOptionsFlags))

Parameters

Batch batch Batch to use

System.String schemaXml A Collaborative Application Markup Language (CAML) string that contains the schema. It must not be a null reference(Nothing in Visual Basic). It must not be empty.It must be a valid Collaborative Application Markup Language(CAML) string according to the schema specified in [MS-WSSFO2], section 2.2.9.3.3.1.

System.Boolean addToDefaultView Specifies to add the field to the default list view. true if the field is added to the default list view; otherwise, false.

AddFieldOptionsFlags options An AddFieldOptionsFlags value that specifies the field options.

Returns

Task<IField> The added field

AddFieldAsXmlBatchAsync(String, Boolean, AddFieldOptionsFlags)

Adds a new field from its XML schema

Declaration

Task<IField> AddFieldAsXmlBatchAsync(string schemaXml, bool addToDefaultView = false, AddFieldOptionsFlags options = default(AddFieldOptionsFlags))

Parameters

System.String schemaXml A Collaborative Application Markup Language (CAML) string that contains the schema. It must not be a null reference(Nothing in Visual Basic). It must not be empty.It must be a valid Collaborative Application Markup Language(CAML) string according to the schema specified in [MS-WSSFO2], section 2.2.9.3.3.1.

System.Boolean addToDefaultView Specifies to add the field to the default list view. true if the field is added to the default list view; otherwise, false.

AddFieldOptionsFlags options An AddFieldOptionsFlags value that specifies the field options.

Returns

Task<IField> The added field

AddLookup(String, FieldLookupOptions)

Adds a new Lookup field to the collection

Declaration

IField AddLookup(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

IField The added field

AddLookupAsync(String, FieldLookupOptions)

Adds a new Lookup field to the collection

Declaration

Task<IField> AddLookupAsync(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

Task<IField> The added field

AddLookupBatch(Batch, String, FieldLookupOptions)

Adds a new Lookup field to the collection

Declaration

IField AddLookupBatch(Batch batch, string title, FieldLookupOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

IField The added field

AddLookupBatch(String, FieldLookupOptions)

Adds a new Lookup field to the collection

Declaration

IField AddLookupBatch(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

IField The added field

AddLookupBatchAsync(Batch, String, FieldLookupOptions)

Adds a new Lookup field to the collection

Declaration

Task<IField> AddLookupBatchAsync(Batch batch, string title, FieldLookupOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

Task<IField> The added field

AddLookupBatchAsync(String, FieldLookupOptions)

Adds a new Lookup field to the collection

Declaration

Task<IField> AddLookupBatchAsync(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

Task<IField> The added field

AddLookupMulti(String, FieldLookupOptions)

Adds a new Lookup Multi field to the collection

Declaration

IField AddLookupMulti(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

IField The added field

AddLookupMultiAsync(String, FieldLookupOptions)

Adds a new Lookup Multi field to the collection

Declaration

Task<IField> AddLookupMultiAsync(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

Task<IField> The added field

AddLookupMultiBatch(Batch, String, FieldLookupOptions)

Adds a new Lookup Multi field to the collection

Declaration

IField AddLookupMultiBatch(Batch batch, string title, FieldLookupOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

IField The added field

AddLookupMultiBatch(String, FieldLookupOptions)

Adds a new Lookup Multi field to the collection

Declaration

IField AddLookupMultiBatch(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

IField The added field

AddLookupMultiBatchAsync(Batch, String, FieldLookupOptions)

Adds a new Lookup Multi field to the collection

Declaration

Task<IField> AddLookupMultiBatchAsync(Batch batch, string title, FieldLookupOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

Task<IField> The added field

AddLookupMultiBatchAsync(String, FieldLookupOptions)

Adds a new Lookup Multi field to the collection

Declaration

Task<IField> AddLookupMultiBatchAsync(string title, FieldLookupOptions options)

Parameters

System.String title The title of the field

FieldLookupOptions options The specific options for field creation

Returns

Task<IField> The added field

AddMultilineText(String, FieldMultilineTextOptions)

Adds a new multiline Text field to the collection

Declaration

IField AddMultilineText(string title, FieldMultilineTextOptions options)

Parameters

System.String title The title of the field

FieldMultilineTextOptions options The specific options for field creation

Returns

IField The added field

AddMultilineTextAsync(String, FieldMultilineTextOptions)

Adds a new multiline Text field to the collection

Declaration

Task<IField> AddMultilineTextAsync(string title, FieldMultilineTextOptions options)

Parameters

System.String title The title of the field

FieldMultilineTextOptions options The specific options for field creation

Returns

Task<IField> The added field

AddMultilineTextBatch(Batch, String, FieldMultilineTextOptions)

Adds a new multiline Text field to the collection

Declaration

IField AddMultilineTextBatch(Batch batch, string title, FieldMultilineTextOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldMultilineTextOptions options The specific options for field creation

Returns

IField The added field

AddMultilineTextBatch(String, FieldMultilineTextOptions)

Adds a new multiline Text field to the collection

Declaration

IField AddMultilineTextBatch(string title, FieldMultilineTextOptions options)

Parameters

System.String title The title of the field

FieldMultilineTextOptions options The specific options for field creation

Returns

IField The added field

AddMultilineTextBatchAsync(Batch, String, FieldMultilineTextOptions)

Adds a new multiline Text field to the collection

Declaration

Task<IField> AddMultilineTextBatchAsync(Batch batch, string title, FieldMultilineTextOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldMultilineTextOptions options The specific options for field creation

Returns

Task<IField> The added field

AddMultilineTextBatchAsync(String, FieldMultilineTextOptions)

Adds a new multiline Text field to the collection

Declaration

Task<IField> AddMultilineTextBatchAsync(string title, FieldMultilineTextOptions options)

Parameters

System.String title The title of the field

FieldMultilineTextOptions options The specific options for field creation

Returns

Task<IField> The added field

AddNumber(String, FieldNumberOptions)

Adds a new Number field to the collection

Declaration

IField AddNumber(string title, FieldNumberOptions options)

Parameters

System.String title The title of the field

FieldNumberOptions options The specific options for field creation

Returns

IField The added field

AddNumberAsync(String, FieldNumberOptions)

Adds a new Number field to the collection

Declaration

Task<IField> AddNumberAsync(string title, FieldNumberOptions options)

Parameters

System.String title The title of the field

FieldNumberOptions options The specific options for field creation

Returns

Task<IField> The added field

AddNumberBatch(Batch, String, FieldNumberOptions)

Adds a new Number field to the collection

Declaration

IField AddNumberBatch(Batch batch, string title, FieldNumberOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldNumberOptions options The specific options for field creation

Returns

IField The added field

AddNumberBatch(String, FieldNumberOptions)

Adds a new Number field to the collection

Declaration

IField AddNumberBatch(string title, FieldNumberOptions options)

Parameters

System.String title The title of the field

FieldNumberOptions options The specific options for field creation

Returns

IField The added field

AddNumberBatchAsync(Batch, String, FieldNumberOptions)

Adds a new Number field to the collection

Declaration

Task<IField> AddNumberBatchAsync(Batch batch, string title, FieldNumberOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldNumberOptions options The specific options for field creation

Returns

Task<IField> The added field

AddNumberBatchAsync(String, FieldNumberOptions)

Adds a new Number field to the collection

Declaration

Task<IField> AddNumberBatchAsync(string title, FieldNumberOptions options)

Parameters

System.String title The title of the field

FieldNumberOptions options The specific options for field creation

Returns

Task<IField> The added field

AddTaxonomy(String, FieldTaxonomyOptions)

Adds a new Taxonomy field to the collection

Declaration

IField AddTaxonomy(string title, FieldTaxonomyOptions options)

Parameters

System.String title The title of the field

FieldTaxonomyOptions options The specific options for field creation

Returns

IField The added field

AddTaxonomyAsync(String, FieldTaxonomyOptions)

Adds a new Taxonomy field to the collection

Declaration

Task<IField> AddTaxonomyAsync(string title, FieldTaxonomyOptions options)

Parameters

System.String title The title of the field

FieldTaxonomyOptions options The specific options for field creation

Returns

Task<IField> The added field

AddTaxonomyMulti(String, FieldTaxonomyOptions)

Adds a new Taxonomy Multi field to the collection

Declaration

IField AddTaxonomyMulti(string title, FieldTaxonomyOptions options)

Parameters

System.String title The title of the field

FieldTaxonomyOptions options The specific options for field creation

Returns

IField The added field

AddTaxonomyMultiAsync(String, FieldTaxonomyOptions)

Adds a new Taxonomy Multi field to the collection

Declaration

Task<IField> AddTaxonomyMultiAsync(string title, FieldTaxonomyOptions options)

Parameters

System.String title The title of the field

FieldTaxonomyOptions options The specific options for field creation

Returns

Task<IField> The added field

AddText(String, FieldTextOptions)

Adds a new Text field to the collection

Declaration

IField AddText(string title, FieldTextOptions options = null)

Parameters

System.String title The title of the field

FieldTextOptions options The specific options for field creation

Returns

IField The added field

AddTextAsync(String, FieldTextOptions)

Adds a new Text field to the collection

Declaration

Task<IField> AddTextAsync(string title, FieldTextOptions options = null)

Parameters

System.String title The title of the field

FieldTextOptions options The specific options for field creation

Returns

Task<IField> The added field

AddTextBatch(Batch, String, FieldTextOptions)

Adds a new Text field to the collection

Declaration

IField AddTextBatch(Batch batch, string title, FieldTextOptions options = null)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldTextOptions options The specific options for field creation

Returns

IField The added field

AddTextBatch(String, FieldTextOptions)

Adds a new Text field to the collection

Declaration

IField AddTextBatch(string title, FieldTextOptions options = null)

Parameters

System.String title The title of the field

FieldTextOptions options The specific options for field creation

Returns

IField The added field

AddTextBatchAsync(Batch, String, FieldTextOptions)

Adds a new Text field to the collection

Declaration

Task<IField> AddTextBatchAsync(Batch batch, string title, FieldTextOptions options = null)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldTextOptions options The specific options for field creation

Returns

Task<IField> The added field

AddTextBatchAsync(String, FieldTextOptions)

Adds a new Text field to the collection

Declaration

Task<IField> AddTextBatchAsync(string title, FieldTextOptions options = null)

Parameters

System.String title The title of the field

FieldTextOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUrl(String, FieldUrlOptions)

Adds a new URL field to the collection

Declaration

IField AddUrl(string title, FieldUrlOptions options)

Parameters

System.String title The title of the field

FieldUrlOptions options The specific options for field creation

Returns

IField The added field

AddUrlAsync(String, FieldUrlOptions)

Adds a new URL field to the collection

Declaration

Task<IField> AddUrlAsync(string title, FieldUrlOptions options)

Parameters

System.String title The title of the field

FieldUrlOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUrlBatch(Batch, String, FieldUrlOptions)

Adds a new URL field to the collection

Declaration

IField AddUrlBatch(Batch batch, string title, FieldUrlOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldUrlOptions options The specific options for field creation

Returns

IField The added field

AddUrlBatch(String, FieldUrlOptions)

Adds a new URL field to the collection

Declaration

IField AddUrlBatch(string title, FieldUrlOptions options)

Parameters

System.String title The title of the field

FieldUrlOptions options The specific options for field creation

Returns

IField The added field

AddUrlBatchAsync(Batch, String, FieldUrlOptions)

Adds a new URL field to the collection

Declaration

Task<IField> AddUrlBatchAsync(Batch batch, string title, FieldUrlOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldUrlOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUrlBatchAsync(String, FieldUrlOptions)

Adds a new URL field to the collection

Declaration

Task<IField> AddUrlBatchAsync(string title, FieldUrlOptions options)

Parameters

System.String title The title of the field

FieldUrlOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUser(String, FieldUserOptions)

Adds a new User field to the collection

Declaration

IField AddUser(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

IField The added field

AddUserAsync(String, FieldUserOptions)

Adds a new User field to the collection

Declaration

Task<IField> AddUserAsync(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUserBatch(Batch, String, FieldUserOptions)

Adds a new User field to the collection

Declaration

IField AddUserBatch(Batch batch, string title, FieldUserOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

IField The added field

AddUserBatch(String, FieldUserOptions)

Adds a new User field to the collection

Declaration

IField AddUserBatch(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

IField The added field

AddUserBatchAsync(Batch, String, FieldUserOptions)

Adds a new User field to the collection

Declaration

Task<IField> AddUserBatchAsync(Batch batch, string title, FieldUserOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUserBatchAsync(String, FieldUserOptions)

Adds a new User field to the collection

Declaration

Task<IField> AddUserBatchAsync(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUserMulti(String, FieldUserOptions)

Adds a new Multi User field to the collection

Declaration

IField AddUserMulti(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

IField The added field

AddUserMultiAsync(String, FieldUserOptions)

Adds a new Multi User field to the collection

Declaration

Task<IField> AddUserMultiAsync(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUserMultiBatch(Batch, String, FieldUserOptions)

Adds a new User Multi field to the collection

Declaration

IField AddUserMultiBatch(Batch batch, string title, FieldUserOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

IField The added field

AddUserMultiBatch(String, FieldUserOptions)

Adds a new User Multi field to the collection

Declaration

IField AddUserMultiBatch(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

IField The added field

AddUserMultiBatchAsync(Batch, String, FieldUserOptions)

Adds a new User Multi field to the collection

Declaration

Task<IField> AddUserMultiBatchAsync(Batch batch, string title, FieldUserOptions options)

Parameters

Batch batch Batch to use

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

Task<IField> The added field

AddUserMultiBatchAsync(String, FieldUserOptions)

Adds a new User Multi field to the collection

Declaration

Task<IField> AddUserMultiBatchAsync(string title, FieldUserOptions options)

Parameters

System.String title The title of the field

FieldUserOptions options The specific options for field creation

Returns

Task<IField> The added field

Extension Methods

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatchAsync<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Batch, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.LoadBatch<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

DataModelCollectionLoadExtensions.Load<TModel>(IDataModelCollectionLoad<TModel>, Expression<Func<TModel, Object>>[])

RequestModuleExtensions.WithHeaders<TModel>(ISupportModules<TModel>, Dictionary<String, String>, Action<Dictionary<String, String>>)

RequestModuleExtensions.WithResponseHeaders<TModel>(ISupportModules<TModel>, Action<Dictionary<String, String>>)

QueryableExtensions.AsRequested<TSource>(IDataModelCollection<TSource>)