Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Visio.Highlight interface

Package:
visio

Represents the highlight data added to the shape.

Remarks

API set: 1.1

Used by

Properties

color

A string that specifies the color of the highlight. It must have the form "#RRGGBB", where each letter represents a hexadecimal digit between 0 and F, and where RR is the red value between 0 and 0xFF (255), GG the green value between 0 and 0xFF (255), and BB is the blue value between 0 and 0xFF (255).
width

A positive integer that specifies the width of the highlight's stroke in pixels.

Property Details

color

A string that specifies the color of the highlight. It must have the form "#RRGGBB", where each letter represents a hexadecimal digit between 0 and F, and where RR is the red value between 0 and 0xFF (255), GG the green value between 0 and 0xFF (255), and BB is the blue value between 0 and 0xFF (255).

color: string;

Property Value

string

Remarks

API set: 1.1

Examples

Visio.run(session, function (ctx) {
 const activePage = ctx.document.getActivePage();
 const shape = activePage.shapes.getItem(0);
 shape.view.highlight.color = "#E7E7E7";
 shape.view.highlight.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));
 }
});

width

A positive integer that specifies the width of the highlight's stroke in pixels.

width: number;

Property Value

number

Remarks

API set: 1.1

Feedback

Was this page helpful?