Class RecordsManagementExtensions

Class that deals with records management functionality

Inheritance

System.Object

RecordsManagementExtensions

Namespace: Microsoft.SharePoint.Client

Assembly: PnP.Framework.dll

Syntax

public static class RecordsManagementExtensions : object

Fields

ECM_ALLOW_MANUAL_DECLARATION

Defines the name of the ECM Allow Manual Declaration propertybag value

Declaration

public const string ECM_ALLOW_MANUAL_DECLARATION = null

Field Value

System.String

ECM_AUTO_DECLARE_RECORDS

Defines the name of the ECM auto declare records propertybag value

Declaration

public const string ECM_AUTO_DECLARE_RECORDS = null

Field Value

System.String

ECM_IPR_LIST_USE_LIST_SPECIFIC

Defines the name of the ECM IPR List use List Specific propertybag value

Declaration

public const string ECM_IPR_LIST_USE_LIST_SPECIFIC = null

Field Value

System.String

ECM_SITE_RECORD_DECLARATION_BY

Defines the name of the ECM Site Record Declaration by propertybag value

Declaration

public const string ECM_SITE_RECORD_DECLARATION_BY = null

Field Value

System.String

ECM_SITE_RECORD_DECLARATION_DEFAULT

Defines the name of the ECM Site Record Declaration Default propertybag value

Declaration

public const string ECM_SITE_RECORD_DECLARATION_DEFAULT = null

Field Value

System.String

ECM_SITE_RECORD_RESTRICTIONS

Defines the name of the ECM Site Record Restrictions propertybag value

Declaration

public const string ECM_SITE_RECORD_RESTRICTIONS = null

Field Value

System.String

ECM_SITE_RECORD_UNDECLARATION_BY

Defines the name of the ECM Site Record Undeclaration by propertybag value

Declaration

public const string ECM_SITE_RECORD_UNDECLARATION_BY = null

Field Value

System.String

INPLACE_RECORDS_MANAGEMENT_FEATURE_ID

Defines the ID of the Inplace Records Management Feature

Declaration

public const string INPLACE_RECORDS_MANAGEMENT_FEATURE_ID = null

Field Value

System.String

Methods

ActivateInPlaceRecordsManagementFeature(Site)

Activate the in place records management feature

Declaration

public static void ActivateInPlaceRecordsManagementFeature(this Site site)

Parameters

Site site Site collection to operate on

DisableInPlaceRecordsManagementFeature(Site)

Deactivate the in place records management feature

Declaration

public static void DisableInPlaceRecordsManagementFeature(this Site site)

Parameters

Site site Site collection to operate on

EnableSiteForInPlaceRecordsManagement(Site)

Enable in place records management. The in place records management feature will be enabled and the in place record management will be enabled in all locations with record declaration allowed by all contributors and undeclaration by site admins

Declaration

public static void EnableSiteForInPlaceRecordsManagement(this Site site)

Parameters

Site site Site collection to operate on

GetListAutoRecordDeclaration(List)

Returns if auto record declaration is active for this list

Declaration

public static bool GetListAutoRecordDeclaration(this List list)

Parameters

List list List to operate against

Returns

System.Boolean True if auto record declaration is active, false otherwise

GetListManualRecordDeclaration(List)

Gets the manual in place record declaration for this list

Declaration

public static EcmListManualRecordDeclaration GetListManualRecordDeclaration(this List list)

Parameters

List list List to operate against

Returns

EcmListManualRecordDeclaration EcmListManualRecordDeclaration enum that defines the manual in place record declaration settings for this list

GetManualRecordDeclarationInAllLocations(Site)

Get the value of the records management is allowed in all places setting

Declaration

public static bool GetManualRecordDeclarationInAllLocations(this Site site)

Parameters

Site site Site collection to operate on

Returns

System.Boolean True if records management is allowed in all places, false otherwise

GetRecordDeclarationBy(Site)

Gets who can declare records

Declaration

public static EcmRecordDeclarationBy GetRecordDeclarationBy(this Site site)

Parameters

Site site Site collection to operate on

Returns

EcmRecordDeclarationBy EcmRecordDeclarationBy enum that defines who can declare a record

GetRecordRestrictions(Site)

Gets the current restrictions on declared records

Declaration

public static EcmSiteRecordRestrictions GetRecordRestrictions(this Site site)

Parameters

Site site Site collection to operate on

Returns

EcmSiteRecordRestrictions EcmSiteRecordRestrictions enum that defines the current restrictions

GetRecordUnDeclarationBy(Site)

Gets who can undeclare records

Declaration

public static EcmRecordDeclarationBy GetRecordUnDeclarationBy(this Site site)

Parameters

Site site Site collection to operate on

Returns

EcmRecordDeclarationBy EcmRecordDeclarationBy enum that defines who can undeclare a record

IsInPlaceRecordsManagementActive(Site)

Checks if in place records management functionality is enabled for this site collection

Declaration

public static bool IsInPlaceRecordsManagementActive(this Site site)

Parameters

Site site Site collection to operate on

Returns

System.Boolean True if in place records management is enabled, false otherwise

IsListRecordSettingDefined(List)

Checks if this list has active in place records management settings defined

Declaration

public static bool IsListRecordSettingDefined(this List list)

Parameters

List list List to operate against

Returns

System.Boolean True if in place records management settings are active for this list

SetListAutoRecordDeclaration(List, Boolean)

Defines if auto record declaration is active for this list: all added items will be automatically declared as a record if active

Declaration

public static void SetListAutoRecordDeclaration(this List list, bool autoDeclareRecords)

Parameters

List list List to operate on

System.Boolean autoDeclareRecords True to automatically declare all added items as record, false otherwise

SetListManualRecordDeclaration(List, EcmListManualRecordDeclaration)

Defines the manual in place record declaration for this list

Declaration

public static void SetListManualRecordDeclaration(this List list, EcmListManualRecordDeclaration settings)

Parameters

List list List to operate against

EcmListManualRecordDeclaration settings EcmListManualRecordDeclaration enum that defines the manual in place record declaration settings for this list

SetManualRecordDeclarationInAllLocations(Site, Boolean)

Defines if in place records management is allowed in all places

Declaration

public static void SetManualRecordDeclarationInAllLocations(this Site site, bool inAllPlaces)

Parameters

Site site Site collection to operate on

System.Boolean inAllPlaces True if allowed in all places, false otherwise

SetRecordDeclarationBy(Site, EcmRecordDeclarationBy)

Defines who can declare records

Declaration

public static void SetRecordDeclarationBy(this Site site, EcmRecordDeclarationBy by)

Parameters

Site site Site collection to operate on

EcmRecordDeclarationBy by EcmRecordDeclarationBy enum that defines who can declare a record

SetRecordRestrictions(Site, EcmSiteRecordRestrictions)

Defines the restrictions that are placed on a document once it's declared as a record

Declaration

public static void SetRecordRestrictions(this Site site, EcmSiteRecordRestrictions restrictions)

Parameters

Site site Site collection to operate on

EcmSiteRecordRestrictions restrictions EcmSiteRecordRestrictions enum that holds the restrictions to be applied

SetRecordUnDeclarationBy(Site, EcmRecordDeclarationBy)

Defines who can undeclare records

Declaration

public static void SetRecordUnDeclarationBy(this Site site, EcmRecordDeclarationBy by)

Parameters

Site site Site collection to operate on

EcmRecordDeclarationBy by EcmRecordDeclarationBy enum that defines who can undeclare a record