Interface IFieldLinkCollection

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

Inherited Members
Namespace: PnP.Core.Model.SharePoint
Assembly: PnP.Core.dll
Syntax
public interface IFieldLinkCollection : IDataModelCollection<IFieldLink>, IDataModelParent, IDataModelWithContext, IRequestableCollection, IDataModelCollectionLoad<IFieldLink>, IDataModelCollectionDeleteByGuidId, ISupportModules<IFieldLinkCollection>

Methods

Add(IField, String, Boolean, Boolean, Boolean, Boolean)

Adds a field link for the given field

Declaration
IFieldLink Add(IField field, string displayName = null, bool hidden = false, bool required = false, bool readOnly = false, bool showInDisplayForm = true)
Parameters
IField field

Field to add as field link
System.String displayName

Display name of the field
System.Boolean hidden

Field is hidden
System.Boolean required

Field is required
System.Boolean readOnly

Field is read only
System.Boolean showInDisplayForm

Show the field in the display form
Returns
IFieldLink

added FieldLink

AddAsync(IField, String, Boolean, Boolean, Boolean, Boolean)

Adds a field link for the given field

Declaration
Task<IFieldLink> AddAsync(IField field, string displayName = null, bool hidden = false, bool required = false, bool readOnly = false, bool showInDisplayForm = true)
Parameters
IField field

Field to add as field link
System.String displayName

Display name of the field
System.Boolean hidden

Field is hidden
System.Boolean required

Field is required
System.Boolean readOnly

Field is read only
System.Boolean showInDisplayForm

Show the field in the display form
Returns
Task<IFieldLink>

added FieldLink

AddBatch(IField)

Adds a field link via a batch

Declaration
void AddBatch(IField field)
Parameters
IField field

Field to add as field link

AddBatch(Batch, IField)

Adds a field link via a batch

Declaration
void AddBatch(Batch batch, IField field)
Parameters
Batch batch

Batcht to add this request to
IField field

Field to add as field link

AddBatchAsync(IField)

Adds a field link via a batch

Declaration
Task AddBatchAsync(IField field)
Parameters
IField field

Field to add as field link
Returns
Task

AddBatchAsync(Batch, IField)

Adds a field link via a batch

Declaration
Task AddBatchAsync(Batch batch, IField field)
Parameters
Batch batch

Batcht to add this request to
IField field

Field to add as field link
Returns
Task

Extension Methods