Visio.Shape class
Stellt die Shape-Klasse dar.
- Extends
Hinweise
[ API-Satz: 1.1 ]
Eigenschaften
| comments | Gibt die Kommentarauflistung zurück. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| hyperlinks | Gibt die Hyperlinks-Auflistung für ein Shape-Objekt zurück. |
| id | Bezeichner des Shapes. |
| name | Der Name des Shapes. |
| select | Gibt „True“ zurück, wenn das Shape ausgewählt ist. Der Benutzer kann „true“ festlegen, um das Shape explizit auszuwählen. |
| shape |
Gibt den Datenabschnitt des Shapes zurück. |
| sub |
Ruft die SubShape-Auflistung ab. |
| text | Der Text der Form. |
| view | Gibt die Ansicht des Shapes zurück. |
Methoden
| get |
Gibt das AbsoluteBoundingBox-Objekt zurück, das den absoluten Begrenzungsrahmen der Form angibt. |
| get |
Gibt das BoundingBox-Objekt zurück, das das umgebende Feld des Shapes angibt. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
comments
Gibt die Kommentarauflistung zurück.
readonly comments: Visio.CommentCollection;Eigenschaftswert
Hinweise
[ API-Satz: 1.1 ]
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
hyperlinks
Gibt die Hyperlinks-Auflistung für ein Shape-Objekt zurück.
readonly hyperlinks: Visio.HyperlinkCollection;Eigenschaftswert
Hinweise
[ API-Satz: 1.1 ]
id
name
select
Gibt „True“ zurück, wenn das Shape ausgewählt ist. Der Benutzer kann „true“ festlegen, um das Shape explizit auszuwählen.
select: boolean;Eigenschaftswert
boolean
Hinweise
[ API-Satz: 1.1 ]
shapeDataItems
Gibt den Datenabschnitt des Shapes zurück.
readonly shapeDataItems: Visio.ShapeDataItemCollection;Eigenschaftswert
Hinweise
[ API-Satz: 1.1 ]
subShapes
Ruft die SubShape-Auflistung ab.
readonly subShapes: Visio.ShapeCollection;Eigenschaftswert
Hinweise
[ API-Satz: 1.1 ]
text
view
Gibt die Ansicht des Shapes zurück.
readonly view: Visio.ShapeView;Eigenschaftswert
Hinweise
[ API-Satz: 1.1 ]
Details zur Methode
getAbsoluteBounds()
Gibt das AbsoluteBoundingBox-Objekt zurück, das den absoluten Begrenzungsrahmen der Form angibt.
getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Gibt zurück
Hinweise
[ API-Satz: 1.1 ]
getBounds()
Gibt das BoundingBox-Objekt zurück, das das umgebende Feld des Shapes angibt.
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Gibt zurück
Hinweise
[ API-Satz: 1.1 ]
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(options?: Visio.Interfaces.ShapeLoadOptions): Visio.Shape;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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(propertyNames?: string | string[]): Visio.Shape;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shapeName = "Sample Name";
const shape = activePage.shapes.getItem(shapeName);
shape.load(["name", "id", "text", "select"]);
return ctx.sync().then(function () {
console.log(shape.name);
console.log(shape.id);
console.log(shape.text);
console.log(shape.select);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shape = activePage.shapes.getItem(0);
shape.view.highlight = { color: "#E7E7E7", width: 100 };
return ctx.sync();
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
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.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Shape;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Visio.Interfaces.ShapeUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Visio.Shape): void;Parameter
- properties
- Visio.Shape
Gibt zurück
void
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 das Objekt übergeben wird.) Während das ursprüngliche Visio.Shape-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Visio.Interfaces.ShapeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Visio.Interfaces.ShapeData;Gibt zurück
Office Add-ins