ExcelScript.RangeHyperlink interface

Paket:

ExcelScript

Stellt die erforderlichen Zeichenfolgen zum Abrufen/Festlegen eines Hyperlinkobjekts (XHL) dar.

Hinweise

Beispiele

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

Eigenschaften

address	Stellt das URL-Ziel für den Link dar.
documentReference	Stellt das Dokumentverweisziel für den Link dar.
screenTip	Stellt die Zeichenfolge dar, die angezeigt wird, wenn mit dem Mauszeiger über den Link gefahren wird.
textToDisplay	Stellt die Zeichenfolge dar, die in der oberen linken Zelle des Bereichs angezeigt wird.

Details zur Eigenschaft

address

Stellt das URL-Ziel für den Link dar.

address?: string;

Eigenschaftswert

string

documentReference

Stellt das Dokumentverweisziel für den Link dar.

documentReference?: string;

Eigenschaftswert

string

Beispiele

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

Stellt die Zeichenfolge dar, die angezeigt wird, wenn mit dem Mauszeiger über den Link gefahren wird.

screenTip?: string;

Eigenschaftswert

string

textToDisplay

Stellt die Zeichenfolge dar, die in der oberen linken Zelle des Bereichs angezeigt wird.

textToDisplay?: string;

Eigenschaftswert

string