ExcelScript.RangeHyperlink interface

Pacote:

ExcelScript

Representa as cadeias necessárias para obter/definir um objeto de hiperligação (XHL).

Comentários

Exemplos

/**
 * This script puts a link to a webpage in a cell.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Create a link to a webpage.
  const sampleHyperlink : ExcelScript.RangeHyperlink = {
    address: "https://learn.microsoft.com/office/dev/scripts/resources/samples/table-of-contents",
    screenTip: "Sample: Create a workbook table of contents",
    textToDisplay: "Learn how to make a workbook table of contents"
  }

  // Put the link in the cell and format the width to fit.
  cell.setHyperlink(sampleHyperlink);
  cell.getFormat().autofitColumns();
}

Propriedades

address	Representa o destino do URL da hiperligação.
documentReference	Representa o destino de referência do documento para a hiperligação.
screenTip	Representa a cadeia exibida ao passar o mouse sobre o hiperlink.
textToDisplay	Representa a cadeia de caracteres exibida na parte superior esquerda da maioria das células no intervalo.

Detalhes da propriedade

address

Representa o destino do URL da hiperligação.

address?: string;

Valor da propriedade

string

documentReference

Representa o destino de referência do documento para a hiperligação.

documentReference?: string;

Valor da propriedade

string

Exemplos

/**
 * This script creates a hyperlink in the current cell to a table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected cell.
  const selectedCell = workbook.getActiveCell();

  // Create a hyperlink from the current cell to a table named "Resources".
  const link : ExcelScript.RangeHyperlink = {
    documentReference: "Resources",
    screenTip: "Resources table",
    textToDisplay: "Go to table"
  } ;

  selectedCell.setHyperlink(link)
}

screenTip

Representa a cadeia exibida ao passar o mouse sobre o hiperlink.

screenTip?: string;

Valor da propriedade

string

textToDisplay

Representa a cadeia de caracteres exibida na parte superior esquerda da maioria das células no intervalo.

textToDisplay?: string;

Valor da propriedade

string