InsertHyperlink

Fügt einen Hyperlink in das Dokument ein.

public Field InsertHyperlink(string displayText, string urlOrBookmark, bool isBookmark)
ParameterTypBeschreibung
displayTextStringText des Links, der im Dokument angezeigt werden soll.
urlOrBookmarkStringLinkziel. Kann eine URL oder der Name eines Lesezeichens im Dokument sein. Diese Methode fügt immer Apostrophe am Anfang und Ende der URL hinzu.
isBookmarkBooleanWAHR wenn der vorherige Parameter ein Name eines Lesezeichens im Dokument ist; FALSCH ist der vorherige Parameter eine URL.

Rückgabewert

AField Objekt, das das eingefügte Feld darstellt.

Bemerkungen

Beachten Sie, dass Sie die Schriftartformatierung für den Hyperlink-Anzeigetext explizit mithilfe von angeben müssenFont Eigentum.

Diese Methode ruft intern aufInsertField um ein MS Word HYPERLINK field in das Dokument einzufügen.

Beispiele

Zeigt, wie ein Hyperlink eingefügt wird, der auf ein lokales Lesezeichen verweist.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.StartBookmark("Bookmark1");
builder.Write("Bookmarked text. ");
builder.EndBookmark("Bookmark1");
builder.Writeln("Text outside of the bookmark.");

// Ein HYPERLINK-Feld einfügen, das auf das Lesezeichen verweist. Wir können Feldschalter passieren
// an die Methode „InsertHyperlink“ als Teil des Arguments, das den Namen des referenzierten Lesezeichens enthält.
builder.Font.Color = Color.Blue;
builder.Font.Underline = Underline.Single;
builder.InsertHyperlink("Link to Bookmark1", @"Bookmark1"" \o ""Hyperlink Tip", true);

doc.Save(ArtifactsDir + "DocumentBuilder.InsertHyperlinkToLocalBookmark.docx");

Zeigt, wie ein Hyperlinkfeld eingefügt wird.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("For more information, please visit the ");

// Einen Hyperlink einfügen und ihn mit benutzerdefinierter Formatierung hervorheben.
// Der Hyperlink ist ein anklickbarer Text, der uns zu dem in der URL angegebenen Ort führt.
builder.Font.Color = Color.Blue;
builder.Font.Underline = Underline.Single;
builder.InsertHyperlink("Google website", "https://www.google.com", false);
builder.Font.ClearFormatting();
builder.Writeln(".");

// Strg + Linksklick auf den Link im Text in Microsoft Word führt uns über ein neues Webbrowser-Fenster zur URL.
doc.Save(ArtifactsDir + "DocumentBuilder.InsertHyperlink.docx");

Zeigt, wie der Formatierungsstapel eines Document Builders verwendet wird.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Richten Sie die Schriftartformatierung ein und schreiben Sie dann den Text, der vor dem Hyperlink steht.
builder.Font.Name = "Arial";
builder.Font.Size = 24;
builder.Write("To visit Google, hold Ctrl and click ");

// Behalten Sie unsere aktuelle Formatierungskonfiguration auf dem Stapel bei.
builder.PushFont();

// Ändern Sie die aktuelle Formatierung des Builders, indem Sie einen neuen Stil anwenden.
builder.Font.StyleIdentifier = StyleIdentifier.Hyperlink;
builder.InsertHyperlink("here", "http://www.google.com", false);

Assert.AreEqual(Color.Blue.ToArgb(), builder.Font.Color.ToArgb());
Assert.AreEqual(Underline.Single, builder.Font.Underline);

// Stellen Sie die zuvor gespeicherte Schriftartformatierung wieder her und entfernen Sie das Element vom Stapel.
builder.PopFont();

Assert.AreEqual(Color.Empty.ToArgb(), builder.Font.Color.ToArgb());
Assert.AreEqual(Underline.None, builder.Font.Underline);

builder.Write(". We hope you enjoyed the example.");

doc.Save(ArtifactsDir + "DocumentBuilder.PushPopFont.docx");

Siehe auch

DocumentBuilder.InsertHtml DocumentBuilder.InsertImage