Word.SensitivityLabelDetails class

Paket:
word

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt die Eigenschaften verfügbarer Vertraulichkeitsbezeichnungen in Word dar.

Extends
OfficeExtension.ClientObject

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

Verwendet von

Eigenschaften

abacAttributeValues

Die ATTRIBUT-Werte der attributbasierten Zugriffssteuerung (ABAC), die der Vertraulichkeitsbezeichnung zugeordnet sind.
children

Die untergeordneten Bezeichnungen der Vertraulichkeitsbezeichnung. Gibt Null zurück, wenn eine Bezeichnung keine untergeordneten Bezeichnungen enthält.
color

Die Farbe der Vertraulichkeitsbezeichnung.
context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
id

Der eindeutige Bezeichner (GUID) der Vertraulichkeitsbezeichnung.
isAbacAttributesRequired

Gibt an, ob bei der Anwendung der Vertraulichkeitsbezeichnung Attribute für die attributbasierte Zugriffssteuerung (ABAC) erforderlich sind.
isAbacEnabled

Gibt an, ob die Vertraulichkeitsbezeichnung Attribute für die attributbasierte Zugriffssteuerung (ABAC) unterstützt.
isEnabled

Ruft einen Wert ab, der angibt, ob die Bezeichnung aktiviert ist.
name

Der Name der Vertraulichkeitsbezeichnung.
order

Die Reihenfolge der Vertraulichkeitsbezeichnung.
protectionType

Ruft einen Wert ab, der den von dieser Bezeichnung bereitgestellten Schutztyp angibt.
siteId

Die eindeutige ID (GUID) des Mandanten, zu dem die Vertraulichkeitsbezeichnung gehört.
tooltip

Die Beschreibung der Vertraulichkeitsbezeichnung.

Methoden

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.SensitivityLabelDetails Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.SensitivityLabelDetailsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

abacAttributeValues

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die ATTRIBUT-Werte der attributbasierten Zugriffssteuerung (ABAC), die der Vertraulichkeitsbezeichnung zugeordnet sind.

readonly abacAttributeValues: Word.SensitivityLabelAbacAttributeValue[];

Eigenschaftswert

Word.SensitivityLabelAbacAttributeValue[]

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

children

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die untergeordneten Bezeichnungen der Vertraulichkeitsbezeichnung. Gibt Null zurück, wenn eine Bezeichnung keine untergeordneten Bezeichnungen enthält.

readonly children: Word.SensitivityLabelDetailsCollection;

Eigenschaftswert

Word.SensitivityLabelDetailsCollection

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

color

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Farbe der Vertraulichkeitsbezeichnung.

readonly color: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

context

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Word.RequestContext

id

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der eindeutige Bezeichner (GUID) der Vertraulichkeitsbezeichnung.

readonly id: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

isAbacAttributesRequired

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob bei der Anwendung der Vertraulichkeitsbezeichnung Attribute für die attributbasierte Zugriffssteuerung (ABAC) erforderlich sind.

readonly isAbacAttributesRequired: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

isAbacEnabled

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob die Vertraulichkeitsbezeichnung Attribute für die attributbasierte Zugriffssteuerung (ABAC) unterstützt.

readonly isAbacEnabled: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

isEnabled

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft einen Wert ab, der angibt, ob die Bezeichnung aktiviert ist.

readonly isEnabled: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

name

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Der Name der Vertraulichkeitsbezeichnung.

readonly name: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

order

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Reihenfolge der Vertraulichkeitsbezeichnung.

readonly order: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

protectionType

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft einen Wert ab, der den von dieser Bezeichnung bereitgestellten Schutztyp angibt.

readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";

Eigenschaftswert

Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

siteId

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die eindeutige ID (GUID) des Mandanten, zu dem die Vertraulichkeitsbezeichnung gehört.

readonly siteId: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

tooltip

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Die Beschreibung der Vertraulichkeitsbezeichnung.

readonly tooltip: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApi BETA (NUR VORSCHAU)

Details zur Methode

load(options)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;

Parameter

options
Word.Interfaces.SensitivityLabelDetailsLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Word.SensitivityLabelDetails

load(propertyNames)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Word.SensitivityLabelDetails;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.SensitivityLabelDetails

load(propertyNamesAndPaths)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.SensitivityLabelDetails;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Word.SensitivityLabelDetails

toJSON()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.SensitivityLabelDetails Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.SensitivityLabelDetailsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.SensitivityLabelDetailsData;

Gibt zurück

Word.Interfaces.SensitivityLabelDetailsData

track()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

track(): Word.SensitivityLabelDetails;

Gibt zurück

Word.SensitivityLabelDetails

untrack()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.SensitivityLabelDetails;

Gibt zurück

Word.SensitivityLabelDetails