ExcelScript.RangeHyperlink interface

Paquet:

ExcelScript

Représente les chaînes nécessaires pour obtenir/définir un objet de lien hypertexte (XHL).

Remarques

Exemples

/**
 * 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();
}

Propriétés

address	Représente la cible d’URL pour le lien hypertexte.
documentReference	Représente la cible de référence de document pour le lien hypertexte.
screenTip	Représente la chaîne affichée lorsque vous pointez sur le lien hypertexte.
textToDisplay	Représente la chaîne qui s’affiche dans la cellule en haut à gauche de la plage.

Détails de la propriété

address

Représente la cible d’URL pour le lien hypertexte.

address?: string;

Valeur de propriété

string

documentReference

Représente la cible de référence de document pour le lien hypertexte.

documentReference?: string;

Valeur de propriété

string

Exemples

/**
 * 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

Représente la chaîne affichée lorsque vous pointez sur le lien hypertexte.

screenTip?: string;

Valeur de propriété

string

textToDisplay

Représente la chaîne qui s’affiche dans la cellule en haut à gauche de la plage.

textToDisplay?: string;

Valeur de propriété

string