Class ExcelSensibilityLabel

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

Inheritance

object

ExcelSensibilityLabel

Implements

IExcelSensibilityLabel

IExcelSensibilityLabelUpdate

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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
string

ContentBits

Content bits.

Declaration

public eContentBits ContentBits { get; }

Property Value

Type	Description
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
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
bool

Id

The sensitivity label id. Guid.

Declaration

public string Id { get; }

Property Value

Type	Description
string

Method

The method.

Declaration

public eMethod Method { get; }

Property Value

Type	Description
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
string

Parent

The parent label, if any.

Declaration

public IExcelSensibilityLabel Parent { get; }

Property Value

Type	Description
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
bool

SiteId

The Azure AD site id. Guid.

Declaration

public string SiteId { get; }

Property Value

Type	Description
string

Tooltip

The description of the sensibility label for the end user.

Declaration

public string Tooltip { get; }

Property Value

Type	Description
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
string	name	The name of the label
string	tooltip	The tooltip for the label
string	description	The desription
string	color	The RGB color in hex
IExcelSensibilityLabel	parent	The id of the parent of the label.

Implements

OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabel

OfficeOpenXml.Interfaces.SensitivityLabels.IExcelSensibilityLabelUpdate