visio package

Klassen

Visio.Application

Stellt die Anwendung dar.

[API-Satz: 1.1]

Visio.Comment

Stellt den Kommentar dar.

[API-Satz: 1.1]

Visio.CommentCollection

Stellt die CommentCollection für ein bestimmtes Shape dar.

[API-Satz: 1.1]

Visio.Document

Stellt die Document-Klasse dar.

[API-Satz: 1.1]

Visio.DocumentView

Stellt die DocumentView-Klasse dar.

[API-Satz: 1.1]

Visio.Hyperlink

Stellt den Hyperlink dar.

[API-Satz: 1.1]

Visio.HyperlinkCollection

Stellt die Hyperlinkauflistung dar.

[API-Satz: 1.1]

Visio.Page

Stellt die Page-Klasse dar.

[API-Satz: 1.1]

Visio.PageCollection

Stellt eine Auflistung von Page-Objekten dar, die Teil des Dokuments sind.

[API-Satz: 1.1]

Visio.PageView

Stellt die PageView-Klasse dar.

[API-Satz: 1.1]

Visio.RequestContext

Das RequestContext-Objekt erleichtert das Senden von Anforderungen an die Visio-Anwendung. Da das Office-Add-In und die Visio-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist der Anforderungskontext erforderlich, um über das Add-In Zugriff auf das Visio-Objektmodell zu erhalten.

Visio.Selection

Stellt die Auswahl auf der Seite dar.

[API-Satz: 1.1]

Visio.Shape

Stellt die Shape-Klasse dar.

[API-Satz: 1.1]

Visio.ShapeCollection

Stellt die Shape-Auflistung dar.

[API-Satz: 1.1]

Visio.ShapeDataItem

Stellt das ShapeDataItem dar.

[API-Satz: 1.1]

Visio.ShapeDataItemCollection

Stellt die ShapeDataItemCollection für ein bestimmtes Shape dar.

[API-Satz: 1.1]

Visio.ShapeView

Stellt die ShapeView-Klasse dar.

[API-Satz: 1.1]

Schnittstellen

Visio.BoundingBox

Stellt die BoundingBox des Shapes dar.

[API-Satz: 1.1]

Visio.DataRefreshCompleteEventArgs

Stellt Informationen zu dem Dokument bereit, das das DataRefreshComplete-Ereignis ausgelöst hat.

[API-Satz: 1.1]

Visio.DocumentLoadCompleteEventArgs

Stellt Informationen zum Erfolg oder Fehler des DocumentLoadComplete-Ereignisses zur Verfügung.

[API-Satz: 1.1]

Visio.Highlight

Stellt die Hervorhebungsdatem dar, die dem Shape hinzugefügt wurden.

[API-Satz: 1.1]

Visio.Interfaces.ApplicationData

Eine Schnittstelle, die die durch Aufrufen von "application.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ApplicationLoadOptions

Stellt die Anwendung dar.

[API-Satz: 1.1]

Visio.Interfaces.ApplicationUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im Application-Objekt zur Verwendung in "application.set({ ... })".

Visio.Interfaces.CollectionLoadOptions

Bietet Möglichkeiten zum Laden von Eigenschaften nur einer Teilmenge von Mitgliedern einer Auflistung.

Visio.Interfaces.CommentCollectionData

Eine Schnittstelle, die die durch aufrufen von "commentCollection.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.CommentCollectionLoadOptions

Stellt die CommentCollection für ein bestimmtes Shape dar.

[API-Satz: 1.1]

Visio.Interfaces.CommentCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im CommentCollection-Objekt zur Verwendung in "commentCollection.set({ ... })".

Visio.Interfaces.CommentData

Eine Schnittstelle, die die durch Aufrufen von "comment.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.CommentLoadOptions

Stellt den Kommentar dar.

[API-Satz: 1.1]

Visio.Interfaces.CommentUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im Comment-Objekt zur Verwendung in "comment.set({ ... })".

Visio.Interfaces.DocumentData

Eine Schnittstelle, die die durch aufrufen von "document.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.DocumentLoadOptions

Stellt die Document-Klasse dar.

[API-Satz: 1.1]

Visio.Interfaces.DocumentUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im Document-Objekt zur Verwendung in "document.set({ ... })".

Visio.Interfaces.DocumentViewData

Eine Schnittstelle, die die durch aufrufen von "documentView.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.DocumentViewLoadOptions

Stellt die DocumentView-Klasse dar.

[API-Satz: 1.1]

Visio.Interfaces.DocumentViewUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im DocumentView-Objekt zur Verwendung in "documentView.set({ ... })".

Visio.Interfaces.HyperlinkCollectionData

Eine Schnittstelle, die die durch aufrufen von "hyperlinkCollection.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.HyperlinkCollectionLoadOptions

Stellt die Hyperlinkauflistung dar.

[API-Satz: 1.1]

Visio.Interfaces.HyperlinkCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im HyperlinkCollection-Objekt zur Verwendung in "hyperlinkCollection.set({ ... })".

Visio.Interfaces.HyperlinkData

Eine Schnittstelle, die die durch Aufrufen von "hyperlink.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.HyperlinkLoadOptions

Stellt den Hyperlink dar.

[API-Satz: 1.1]

Visio.Interfaces.PageCollectionData

Eine Schnittstelle, die die durch aufrufen von "pageCollection.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.PageCollectionLoadOptions

Stellt eine Auflistung von Page-Objekten dar, die Teil des Dokuments sind.

[API-Satz: 1.1]

Visio.Interfaces.PageCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im PageCollection-Objekt zur Verwendung in "pageCollection.set({ ... })".

Visio.Interfaces.PageData

Eine Schnittstelle, die die durch aufrufen von "page.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.PageLoadOptions

Stellt die Page-Klasse dar.

[API-Satz: 1.1]

Visio.Interfaces.PageUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im Page-Objekt zur Verwendung in "page.set({ ... })".

Visio.Interfaces.PageViewData

Eine Schnittstelle, die die durch Aufrufen von "pageView.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.PageViewLoadOptions

Stellt die PageView-Klasse dar.

[API-Satz: 1.1]

Visio.Interfaces.PageViewUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im PageView-Objekt zur Verwendung in "pageView.set({ ... })".

Visio.Interfaces.SelectionData

Eine Schnittstelle, die die durch Aufrufen von "selection.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ShapeCollectionData

Eine Schnittstelle, die die durch aufrufen von "shapeCollection.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ShapeCollectionLoadOptions

Stellt die Shape-Auflistung dar.

[API-Satz: 1.1]

Visio.Interfaces.ShapeCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im ShapeCollection-Objekt zur Verwendung in "shapeCollection.set({ ... })".

Visio.Interfaces.ShapeData

Eine Schnittstelle, die die durch den Aufruf von "shape.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ShapeDataItemCollectionData

Eine Schnittstelle, die die durch aufrufen von "shapeDataItemCollection.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ShapeDataItemCollectionLoadOptions

Stellt die ShapeDataItemCollection für ein bestimmtes Shape dar.

[API-Satz: 1.1]

Visio.Interfaces.ShapeDataItemCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im ShapeDataItemCollection-Objekt zur Verwendung in "shapeDataItemCollection.set({ ... })".

Visio.Interfaces.ShapeDataItemData

Eine Schnittstelle, die die durch den Aufruf von "shapeDataItem.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ShapeDataItemLoadOptions

Stellt das ShapeDataItem dar.

[API-Satz: 1.1]

Visio.Interfaces.ShapeLoadOptions

Stellt die Shape-Klasse dar.

[API-Satz: 1.1]

Visio.Interfaces.ShapeUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Shape-Objekt zur Verwendung in "shape.set({ ... })".

Visio.Interfaces.ShapeViewData

Eine Schnittstelle, die die durch aufrufen von "shapeView.toJSON()" zurückgegebenen Daten beschreibt.

Visio.Interfaces.ShapeViewLoadOptions

Stellt die ShapeView-Klasse dar.

[API-Satz: 1.1]

Visio.Interfaces.ShapeViewUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im ShapeView-Objekt zur Verwendung in "shapeView.set({ ... })".

Visio.PageLoadCompleteEventArgs

Stellt Informationen zu der Seite bereit, die das PageLoadComplete-Ereignis ausgelöst hat.

[API-Satz: 1.1]

Visio.PageRenderCompleteEventArgs

Enthält Informationen zur Seite, die das PageRenderComplete-Ereignis ausgelöst hat.

[API-Satz: 1.1]

Visio.Position

Stellt die Position des Objekts in der Ansicht dar.

[API-Satz: 1.1]

Visio.SelectionChangedEventArgs

Stellt Informationen zu der Shape-Auflistung bereit, die das SelectionChanged-Ereignis ausgelöst hat.

[API-Satz: 1.1]

Visio.ShapeMouseEnterEventArgs

Enthält Informationen zum Shape, das das ShapeMouseEnter-Ereignis ausgelöst hat.

[API-Satz: 1.1]

Visio.ShapeMouseLeaveEventArgs

Enthält Informationen zum Shape, das das ShapeMouseLeave-Ereignis ausgelöst hat.

[API-Satz: 1.1]

Enumerationen

Visio.ErrorCodes
Visio.OverlayHorizontalAlignment

Represents the Horizontal Alignment of the Overlay relative to the shape.

[API-Satz: 1.1]

Visio.OverlayType

Stellt den Typ der Überlagerung dar.

[API-Satz: 1.1]

Visio.OverlayVerticalAlignment

Represents the Vertical Alignment of the Overlay relative to the shape.

[API-Satz: 1.1]

Visio.ToolBarType

Symbolleisten-IDs der App

[API-Satz: 1.1]

Functions

Visio.run(batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung eines neuen Anforderungskontexts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte freigegeben, die während der Ausführung automatisch zugewiesen wurden.

Visio.run(object, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell mithilfe des Anforderungskontexts eines zuvor erstellten API-Objekts ausführt.

Visio.run(objects, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell mithilfe des Anforderungskontexts zuvor erstellter API-Objekte ausführt.

Visio.run(contextObject, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell mit dem RequestContext eines zuvor erstellten Objekts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte freigegeben, die während der Ausführung automatisch zugewiesen wurden.

Details zur Funktion

Visio.run(batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell unter Verwendung eines neuen Anforderungskontexts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte freigegeben, die während der Ausführung automatisch zugewiesen wurden.

export function run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

Parameter

batch

(context: Visio.RequestContext) => Promise<T>

Eine Funktion, die einen Visio.RequestContext einnimmt und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Der Kontextparameter erleichtert Anforderungen an die Visio-Anwendung. Da das Office-Add-In und die Visio-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist der Anforderungskontext erforderlich, um über das Add-In Zugriff auf das Visio-Objektmodell zu erhalten.

Gibt zurück

Promise<T>

Visio.run(object, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell mithilfe des Anforderungskontexts eines zuvor erstellten API-Objekts ausführt.

export function run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

Parameter

object

OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession

Ein zuvor erstelltes API-Objekt. Der Batch verwendet denselben Anforderungskontext wie das übergebene Objekt, was bedeutet, dass alle auf das Objekt angewendeten Änderungen von "context.sync()" übernommen werden.

batch

(context: Visio.RequestContext) => Promise<T>

Eine Funktion, die einen Visio.RequestContext einnimmt und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte freigegeben, die während der Ausführung automatisch zugewiesen wurden.

Gibt zurück

Promise<T>

Visio.run(objects, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell mithilfe des Anforderungskontexts zuvor erstellter API-Objekte ausführt.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

Parameter

objects

OfficeExtension.ClientObject[]

Ein Array von zuvor erstellten API-Objekten. Das Array wird überprüft, um sicherzustellen, dass alle Objekte denselben Kontext haben. Der Batch verwendet diesen freigegebenen Anforderungskontext, was bedeutet, dass alle änderungen, die auf diese Objekte angewendet werden, von "context.sync()" übernommen werden.

batch

(context: Visio.RequestContext) => Promise<T>

Eine Funktion, die einen Visio.RequestContext einnimmt und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte freigegeben, die während der Ausführung automatisch zugewiesen wurden.

Gibt zurück

Promise<T>

Visio.run(contextObject, batch)

Führt ein Batchskript aus, das Aktionen für das Visio-Objektmodell mit dem RequestContext eines zuvor erstellten Objekts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte freigegeben, die während der Ausführung automatisch zugewiesen wurden.

export function run<T>(contextObject: OfficeExtension.ClientRequestContext, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

Parameter

contextObject
OfficeExtension.ClientRequestContext

Ein zuvor erstelltes Visio.RequestContext-Objekt. Dieser Kontext wird von der Batchfunktion erneut verwendet (anstatt einen neuen Kontext erstellt zu haben). Dies bedeutet, dass der Batch Änderungen an vorhandenen API-Objekten abrufen kann, wenn diese Objekte aus demselben Kontext abgeleitet wurden.

batch

(context: Visio.RequestContext) => Promise<T>

Eine Funktion, die einen RequestContext einnimmt und eine Zusage zurückgibt (in der Regel nur das Ergebnis von "context.sync()"). Der Kontextparameter erleichtert Anforderungen an die Visio-Anwendung. Da das Office-Add-In und die Visio-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist RequestContext erforderlich, um zugriff auf das Visio-Objektmodell über das Add-In zu erhalten.

Gibt zurück

Promise<T>

Hinweise

Zusätzlich zu dieser Signatur verfügt die Methode auch über die folgenden Signaturen:

run<T>(batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

run<T>(object: OfficeExtension.ClientObject | OfficeExtension.EmbeddedSession, batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;

run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Visio.RequestContext) => Promise<T>): Promise<T>;