BuiltInDocumentPropertiesHyperlinkBase Property

Specifies the base string used for evaluating relative hyperlinks in this document.

Namespace:  Aspose.Words.Properties
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 21.3.0


public string HyperlinkBase { get; set; }

Property Value

Type: String


Aspose.Words does not use this property.


Shows how to store the base part of a hyperlink in the document's properties.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a relative hyperlink to a document in the local file system named "Document.docx".
// Clicking on the link in Microsoft Word will open the designated document, if it is available.
builder.InsertHyperlink("Relative hyperlink", "Document.docx", false);

// This link is relative. If there is no "Document.docx" in the same folder
// as the document that contains this link, the link will be broken.
Assert.False(File.Exists(ArtifactsDir + "Document.docx"));
doc.Save(ArtifactsDir + "DocumentProperties.HyperlinkBase.BrokenLink.docx");

// The document we are trying to link to is in a different directory to the one we are planning to save the document in.
// We could fix links like this by putting an absolute filename in each one. 
// Alternatively, we could provide a base link that every hyperlink with a relative filename
// will prepend to its link when we click on it. 
BuiltInDocumentProperties properties = doc.BuiltInDocumentProperties;
properties.HyperlinkBase = MyDir;

Assert.True(File.Exists(properties.HyperlinkBase + ((FieldHyperlink)doc.Range.Fields[0]).Address));

doc.Save(ArtifactsDir + "DocumentProperties.HyperlinkBase.WorkingLink.docx");

ExpandedSee Also