Visio.Shape class
Representa la clase Shape.
- Extends
Comentarios
Usada por
Propiedades
| comments | Devuelve la colección de comentarios. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| hyperlinks | Devuelve la colección hipervínculos para un objeto de forma. |
| id | Identificador de Shape. |
| name | Nombre de la forma. |
| select | Devuelve True, si la forma está seleccionada. Usuario puede establecer True para seleccionar la forma explícitamente. |
| shape |
Devuelve la sección de datos de la forma. |
| sub |
Obtiene la colección de subformas. |
| text | Texto de la forma. |
| view | Devuelve la vista de la forma. |
Métodos
| get |
Devuelve el objeto AbsoluteBoundingBox que especifica el cuadro delimitador absoluto de la forma. |
| get |
Devuelve el objeto BoundingBox que especifica el cuadro de límite de la forma. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
comments
Devuelve la colección de comentarios.
readonly comments: Visio.CommentCollection;Valor de propiedad
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
hyperlinks
Devuelve la colección hipervínculos para un objeto de forma.
readonly hyperlinks: Visio.HyperlinkCollection;Valor de propiedad
Comentarios
id
Identificador de Shape.
readonly id: number;Valor de propiedad
number
Comentarios
name
Nombre de la forma.
readonly name: string;Valor de propiedad
string
Comentarios
select
Devuelve True, si la forma está seleccionada. Usuario puede establecer True para seleccionar la forma explícitamente.
select: boolean;Valor de propiedad
boolean
Comentarios
shapeDataItems
Devuelve la sección de datos de la forma.
readonly shapeDataItems: Visio.ShapeDataItemCollection;Valor de propiedad
Comentarios
subShapes
Obtiene la colección de subformas.
readonly subShapes: Visio.ShapeCollection;Valor de propiedad
Comentarios
text
Texto de la forma.
readonly text: string;Valor de propiedad
string
Comentarios
view
Devuelve la vista de la forma.
readonly view: Visio.ShapeView;Valor de propiedad
Comentarios
Detalles del método
getAbsoluteBounds()
Devuelve el objeto AbsoluteBoundingBox que especifica el cuadro delimitador absoluto de la forma.
getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Devoluciones
Comentarios
getBounds()
Devuelve el objeto BoundingBox que especifica el cuadro de límite de la forma.
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Devoluciones
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Visio.Interfaces.ShapeLoadOptions): Visio.Shape;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Visio.Shape;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
Ejemplos
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)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Shape;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Visio.Interfaces.ShapeUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Visio.Shape): void;Parámetros
- properties
- Visio.Shape
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Visio.Shape original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Visio.Interfaces.ShapeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Visio.Interfaces.ShapeData;