BaseListViewCommandSet class

Paket:

@microsoft/sp-listview-extensibility

Dies ist die Basisklasse, die Drittanbieter erweitern sollten, wenn sie eine clientseitige Erweiterung implementieren, die einen Befehlssatz für eine SharePoint-Listenansicht bereitstellt.

Extends

BaseExtension<TProperties>

Hinweise

Im Komponentenmanifest sollte "extensionType" auf "ListViewCommandSet" festgelegt werden.

Eigenschaften

context

Verwenden Sie das Kontextobjekt, um auf allgemeine Dienste und den Zustand zuzugreifen, die der Komponente zugeordnet sind.

Methoden

onExecute(event)	Dieses Ereignis tritt auf, wenn der Befehl aufgerufen wird, z. B. weil der Benutzer auf die Symbolleistenschaltfläche oder das Menüelement geklickt hat. virtuell
onListViewUpdated(event)	Dieses Ereignis tritt auf, wenn sich der ListView-Zustand ändert. virtuell
raiseOnChange()	Verwenden Sie diese Methode, um das OnChange-Ereignis auszulösen und einen Reflow der ListView zu initialisieren.
tryGetCommand(id)	Gibt den Befehl mit der angegebenen ID zurück. Gibt undefined zurück, wenn kein Befehl mit der angegebenen ID vorhanden ist.

Details zur Eigenschaft

context

Verwenden Sie das Kontextobjekt, um auf allgemeine Dienste und den Zustand zuzugreifen, die der Komponente zugeordnet sind.

readonly context: ListViewCommandSetContext;

Eigenschaftswert

ListViewCommandSetContext

Hinweise

Von untergeordneten Klassen wird erwartet, dass sie dieses Feld überschreiben, indem es mit einem speziellen Typ neu deklariert wird. Es soll eine schreibgeschützte Eigenschaft sein. Der Typ kann in der Basisklasse nicht als schreibgeschützt deklariert werden (da er außerhalb des Konstruktors initialisiert wird), aber untergeordnete Klassen sollten ihn als schreibgeschützt neu definieren.

Details zur Methode

onExecute(event)

Dieses Ereignis tritt auf, wenn der Befehl aufgerufen wird, z. B. weil der Benutzer auf die Symbolleistenschaltfläche oder das Menüelement geklickt hat. virtuell

onExecute(event: IListViewCommandSetExecuteEventParameters): void;

Parameter

event

IListViewCommandSetExecuteEventParameters

Gibt zurück

void

onListViewUpdated(event)

Warnung

Diese API ist nun veraltet.

Use context.listView.listViewStateChangedEvent instead.

Dieses Ereignis tritt auf, wenn sich der ListView-Zustand ändert. virtuell

onListViewUpdated(event: IListViewCommandSetListViewUpdatedParameters): void;

Parameter

event

IListViewCommandSetListViewUpdatedParameters

Gibt zurück

void

Hinweise

Dieses Ereignis ermöglicht es dem Implementor, die Sichtbarkeit des Befehls anzupassen.

raiseOnChange()

Verwenden Sie diese Methode, um das OnChange-Ereignis auszulösen und einen Reflow der ListView zu initialisieren.

raiseOnChange(): void;

Gibt zurück

void

tryGetCommand(id)

Gibt den Befehl mit der angegebenen ID zurück. Gibt undefined zurück, wenn kein Befehl mit der angegebenen ID vorhanden ist.

tryGetCommand(id: string): Command;

Parameter

id

string

ID des Befehls

Gibt zurück

Command