Compartir a través de

Excel.ShapeLineFormat class

  • Referencia
Paquete:
excel

Representa el formato de línea del objeto shape. Para imágenes y formas geométricas, el formato de línea representa el borde de la forma.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

color

Representa el color de línea en formato de color HTML, en el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
dashStyle

Indica el estilo de línea de la forma. Devuelve null cuando la línea no está visible o hay estilos de guion incoherentes. Vea Excel.ShapeLineDashStyle para más información.
style

Indica el estilo de línea de la forma. Devuelve null cuando la línea no está visible o hay estilos incoherentes. Vea Excel.ShapeLineStyle para más información.
transparency

Indica o establece el grado de transparencia de la línea especificada como valor entre 0,0 (opaco) y 1,0 (transparente). Devuelve null cuando la forma tiene transparencias incoherentes.
visible

Especifica si el formato de línea de un elemento de forma está visible. Devuelve null cuando la forma tiene visibilidades incoherentes.
weight

Indica el grosor de la línea, en puntos. Devuelve null cuando la línea no está visible o hay grosores de línea incoherentes.

Métodos

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(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
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 de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ShapeLineFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ShapeLineFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

color

Representa el color de línea en formato de color HTML, en el formato #RRGGBB (por ejemplo, "FFA500") o como un color HTML con nombre (por ejemplo, "naranja").

color: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

dashStyle

Indica el estilo de línea de la forma. Devuelve null cuando la línea no está visible o hay estilos de guion incoherentes. Vea Excel.ShapeLineDashStyle para más información.

dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

Valor de propiedad

Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

style

Indica el estilo de línea de la forma. Devuelve null cuando la línea no está visible o hay estilos incoherentes. Vea Excel.ShapeLineStyle para más información.

style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

Valor de propiedad

Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

transparency

Indica o establece el grado de transparencia de la línea especificada como valor entre 0,0 (opaco) y 1,0 (transparente). Devuelve null cuando la forma tiene transparencias incoherentes.

transparency: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

visible

Especifica si el formato de línea de un elemento de forma está visible. Devuelve null cuando la forma tiene visibilidades incoherentes.

visible: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

weight

Indica el grosor de la línea, en puntos. Devuelve null cuando la línea no está visible o hay grosores de línea incoherentes.

weight: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Detalles del método

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?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;

Parámetros

options
Excel.Interfaces.ShapeLineFormatLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.ShapeLineFormat

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[]): Excel.ShapeLineFormat;

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

Excel.ShapeLineFormat

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;
        }): Excel.ShapeLineFormat;

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

Excel.ShapeLineFormat

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 de API del mismo tipo.

set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.ShapeLineFormatUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de un objeto cargado existente.

set(properties: Excel.ShapeLineFormat): void;

Parámetros

properties
Excel.ShapeLineFormat

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ShapeLineFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ShapeLineFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.ShapeLineFormatData;

Devoluciones

Excel.Interfaces.ShapeLineFormatData