Word.LineFormat class
Representa la línea y el formato de la punta de flecha. En el caso de una línea, el LineFormat objeto contiene información de formato para la propia línea. Para una forma con un borde, este objeto contiene información de formato para el borde de la forma.
- Extends
Propiedades
| background |
Obtiene un |
| begin |
Especifica la longitud de la punta de flecha al principio de la línea. |
| begin |
Especifica el estilo de la punta de flecha al principio de la línea. |
| begin |
Especifica el ancho de la punta de flecha al principio de la línea. |
| 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. |
| dash |
Especifica el estilo de guion de la línea. |
| end |
Especifica la longitud de la punta de flecha al final de la línea. |
| end |
Especifica el estilo de la punta de flecha al final de la línea. |
| end |
Especifica el ancho de la punta de flecha al final de la línea. |
| foreground |
Obtiene un |
| inset |
Especifica si se deben dibujar líneas dentro de una forma. |
| is |
Especifica si el objeto, o el formato que se le aplica, está visible. |
| pattern | Especifica el patrón aplicado a la línea. |
| style | Especifica el estilo de formato de línea. |
| transparency | Especifica el grado de transparencia de la línea como un valor entre 0,0 (opaco) y 1,0 (sin cifrar). |
| weight | Especifica el grosor de la línea en puntos. |
Métodos
| 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 |
| track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre |
| untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar |
Detalles de las propiedades
backgroundColor
Obtiene un ColorFormat objeto que representa el color de fondo de una línea con patrón.
readonly backgroundColor: Word.ColorFormat;Valor de propiedad
Comentarios
beginArrowheadLength
Especifica la longitud de la punta de flecha al principio de la línea.
beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";Valor de propiedad
Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"
Comentarios
beginArrowheadStyle
Especifica el estilo de la punta de flecha al principio de la línea.
beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";Valor de propiedad
Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"
Comentarios
beginArrowheadWidth
Especifica el ancho de la punta de flecha al principio de la línea.
beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";Valor de propiedad
Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"
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
dashStyle
Especifica el estilo de guion de la línea.
dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot";Valor de propiedad
Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"
Comentarios
endArrowheadLength
Especifica la longitud de la punta de flecha al final de la línea.
endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";Valor de propiedad
Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"
Comentarios
endArrowheadStyle
Especifica el estilo de la punta de flecha al final de la línea.
endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";Valor de propiedad
Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"
Comentarios
endArrowheadWidth
Especifica el ancho de la punta de flecha al final de la línea.
endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";Valor de propiedad
Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"
Comentarios
foregroundColor
Obtiene un ColorFormat objeto que representa el color de primer plano de la línea.
readonly foregroundColor: Word.ColorFormat;Valor de propiedad
Comentarios
insetPen
Especifica si se deben dibujar líneas dentro de una forma.
insetPen: boolean;Valor de propiedad
boolean
Comentarios
isVisible
Especifica si el objeto, o el formato que se le aplica, está visible.
isVisible: boolean;Valor de propiedad
boolean
Comentarios
pattern
Especifica el patrón aplicado a la línea.
pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";Valor de propiedad
Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"
Comentarios
style
Especifica el estilo de formato de línea.
style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin";Valor de propiedad
Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"
Comentarios
transparency
Especifica el grado de transparencia de la línea como un valor entre 0,0 (opaco) y 1,0 (sin cifrar).
transparency: number;Valor de propiedad
number
Comentarios
weight
Especifica el grosor de la línea en puntos.
weight: number;Valor de propiedad
number
Comentarios
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?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat;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[]): Word.LineFormat;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
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;
}): Word.LineFormat;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.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Word.Interfaces.LineFormatUpdateData
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: Word.LineFormat): void;Parámetros
- properties
- Word.LineFormat
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 original Word.LineFormat es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.LineFormatData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Word.Interfaces.LineFormatData;Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
track(): Word.LineFormat;Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.
untrack(): Word.LineFormat;