Class ExcelSensibilityLabel

Represents a sensitivity label that can be applied to a package.

Inheritance

System.Object

ExcelSensibilityLabel

Implements

OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabel

OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabelUpdate

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OfficeOpenXml.SensitivityLabels

Assembly: EPPlus.dll

Syntax

public class ExcelSensibilityLabel : IExcelSensibilityLabel, IExcelSensibilityLabelUpdate

Properties

Color

The color of the label.

Declaration

public string Color { get; }

Property Value

Type	Description
System.String

ContentBits

Content bits.

Declaration

public eContentBits ContentBits { get; }

Property Value

Type	Description
OfficeOpenXml.Interfaces.SensitivityLabels.eContentBits

Description

The description of the sensibility label. If no SensibilityLabelHandler is set this property will always be empty.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

Enabled

If the sensibility label is enabled. Only one sensibility label can be enabled in the list.

Declaration

public bool Enabled { get; }

Property Value

Type	Description
System.Boolean

Id

The sensitivity label id. Guid.

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

Method

The method.

Declaration

public eMethod Method { get; }

Property Value

Type	Description
OfficeOpenXml.Interfaces.SensitivityLabels.eMethod

Name

The name of the sensibility label. If no SensibilityLabelHandler is set this property will always be empty.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Parent

The parent label, if any.

Declaration

public IExcelSensibilityLabel Parent { get; }

Property Value

Type	Description
OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabel

Removed

If the sensibility label is removed. If the sensibility label is removed Enabled should be set to false.

Declaration

public bool Removed { get; }

Property Value

Type	Description
System.Boolean

SiteId

The Azure AD site id. Guid.

Declaration

public string SiteId { get; }

Property Value

Type	Description
System.String

Tooltip

The description of the sensibility label for the end user.

Declaration

public string Tooltip { get; }

Property Value

Type	Description
System.String

Methods

Update(String, String, String, String, IExcelSensibilityLabel)

Update properties from the handler

Declaration

public void Update(string name, string tooltip, string description, string color, IExcelSensibilityLabel parent)

Parameters

Type	Name	Description
System.String	name	The name of the label
System.String	tooltip	The tooltip for the label
System.String	description	The desription
System.String	color	The RGB color in hex
OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabel	parent	The id of the parent of the label.

Implements

OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabel

OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabelUpdate