Class ExcelSensibilityLabel¶

Namespace: OfficeOpenXml.SensitivityLabels
Assembly: EPPlus.dll

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

public class ExcelSensibilityLabel : IExcelSensibilityLabel, IExcelSensibilityLabelUpdate

Inheritance¶

object ← ExcelSensibilityLabel

Implements¶

IExcelSensibilityLabel
IExcelSensibilityLabelUpdate

Inherited Members¶

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Constructors¶

ExcelSensibilityLabel()¶

public ExcelSensibilityLabel()

Properties¶

Color¶

The color of the label.

public string Color { get; }

Property Value¶

string

ContentBits¶

Content bits.

public eContentBits ContentBits { get; }

Property Value¶

eContentBits

Description¶

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

public string Description { get; }

Property Value¶

string

Enabled¶

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

public bool Enabled { get; }

Property Value¶

bool

Id¶

The sensitivity label id. Guid.

public string Id { get; }

Property Value¶

string

Method¶

The method.

public eMethod Method { get; }

Property Value¶

eMethod

Name¶

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

public string Name { get; }

Property Value¶

string

Parent¶

The parent label, if any.

public IExcelSensibilityLabel Parent { get; }

Property Value¶

IExcelSensibilityLabel

Removed¶

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

public bool Removed { get; }

Property Value¶

bool

SiteId¶

The Azure AD site id. Guid.

public string SiteId { get; }

Property Value¶

string

Tooltip¶

The description of the sensibility label for the end user.

public string Tooltip { get; }

Property Value¶

string

Methods¶

Update(string, string, string, string, IExcelSensibilityLabel)¶

Update properties from the handler

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

Parameters¶

name string

The name of the label

tooltip string

The tooltip for the label

description string

The desription

color string

The RGB color in hex

parent IExcelSensibilityLabel

The id of the parent of the label.