Word.BorderCollection class

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

Especifica el color de 24 bits de los bordes interiores. El color se especifica en formato "#RRGGBB" o mediante el nombre del color.

insideBorderColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.1

Especifica el tipo de borde de los bordes interiores.

insideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.1

Especifica el ancho de los bordes interiores.

insideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.1

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Word.Border[];

Valor de propiedad

Especifica el color de 24 bits de los bordes exteriores. El color se especifica en formato "#RRGGBB" o mediante el nombre del color.

outsideBorderColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.1

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Sets the outside border color of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.outsideBorderColor = "#4472C4";
  await context.sync();

  console.log("Set the Sample Style outside border color to blue.");
});

Especifica el tipo de borde de los bordes exteriores.

outsideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.1

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Sets the outside border type of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.outsideBorderType = Word.BorderType.dashed;
  await context.sync();

  console.log("Set the Sample Style outside border type to dashed.");
});

Especifica el ancho de los bordes exteriores.

outsideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.1

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Sets the outside border width of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  const borderWidth: Word.BorderWidth = Word.BorderWidth.pt225;
  borders.outsideBorderWidth = borderWidth;
  await context.sync();

  console.log("Set the Sample Style outside border width to 2.25 points.");
});

Obtiene la frontera que tiene la ubicación especificada.

getByLocation(borderLocation: Word.BorderLocation.top | Word.BorderLocation.left | Word.BorderLocation.bottom | Word.BorderLocation.right | Word.BorderLocation.insideHorizontal | Word.BorderLocation.insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"): Word.Border;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Loads all scalar properties and returns them as a plain JavaScript object.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const borders: Word.BorderCollection = style.borders;
  const border: Word.Border = borders.getByLocation(Word.BorderLocation.bottom);
  border.load("color, location, type, visible, width");
  await context.sync();

  console.log("Border properties:", border.toJSON());
});

Obtiene el primer borde de esta colección. Produce un ItemNotFound error si esta colección está vacía.

getFirst(): Word.Border;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Obtiene el primer borde de esta colección. Si esta colección está vacía, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getFirstOrNullObject(): Word.Border;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Obtiene un Border objeto por su índice en la colección.

getItem(index: number): Word.Border;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

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.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderCollection;

Parámetros

Devoluciones

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.BorderCollection;

Parámetros

Devoluciones

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BorderCollection;

Parámetros

Devoluciones

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.BorderCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.BorderCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.

toJSON(): Word.Interfaces.BorderCollectionData;

Devoluciones

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.BorderCollection;

Devoluciones

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.BorderCollection;

Devoluciones