C1.C1Preview.ParagraphObjectCollection.AddHyperlink

AddHyperlink Method

AddHyperlink(string, string)

Adds a text hyperlink to the current paragraph content.

Declaration

public ParagraphText AddHyperlink(string text, string anchorName)

Public Function AddHyperlink(text As String, anchorName As String) As ParagraphText

Parameters

Type	Name	Description
string	text	The text string to add.
string	anchorName	The name of the anchor which is the target of the hyperlink.

Returns

Type	Description
ParagraphText	A ParagraphText object representing the specified text string, associated with the specified hyperlink.

Remarks

This method creates a ParagraphText, initializes it with the specified text, sets the Hyperlink on that object to a C1Hyperlink initialized with anchorName, and adds it to the current collection.

AddHyperlink(string, string, Style)

Adds a text hyperlink with a specified style to the current paragraph content.

Declaration

public ParagraphText AddHyperlink(string text, string anchorName, Style style)

Public Function AddHyperlink(text As String, anchorName As String, style As Style) As ParagraphText

Parameters

Type	Name	Description
string	text	The text string to add.
string	anchorName	The name of the anchor which is the target of the hyperlink.
Style	style	A style used to render the string.

Returns

Type	Description
ParagraphText	A ParagraphText object representing the specified text string, associated with the specified hyperlink.

Remarks

This method creates a ParagraphText, initializes it with the specified text and style, sets the Hyperlink on that object to a C1Hyperlink initialized with anchorName, and adds it to the current collection.

AddHyperlink(string, C1LinkTarget)

Adds a text hyperlink to the current paragraph content.

Declaration

public ParagraphText AddHyperlink(string text, C1LinkTarget target)

Public Function AddHyperlink(text As String, target As C1LinkTarget) As ParagraphText

Parameters

Type	Name	Description
string	text	The text string to add.
C1LinkTarget	target	A C1LinkTarget which is the target of the hyperlink.

Returns

Type	Description
ParagraphText	A ParagraphText object representing the specified text string, associated with the specified hyperlink.

Remarks

This method creates a ParagraphText, initializes it with the specified text, sets the Hyperlink on that object to a C1Hyperlink initialized with target, and adds it to the current collection.

AddHyperlink(string, C1LinkTarget, Style)

Adds a text hyperlink with a specified style to the current paragraph content.

Declaration

public ParagraphText AddHyperlink(string text, C1LinkTarget target, Style style)

Public Function AddHyperlink(text As String, target As C1LinkTarget, style As Style) As ParagraphText

Parameters

Type	Name	Description
string	text	The text string to add.
C1LinkTarget	target	A C1LinkTarget which is the target of the hyperlink.
Style	style	A style used to render the string.

Returns

Type	Description
ParagraphText	A ParagraphText object representing the specified text string, associated with the specified hyperlink.

Remarks

This method creates a ParagraphText, initializes it with the specified text and style, sets the Hyperlink on that object to a C1Hyperlink initialized with target, and adds it to the current collection.

AddHyperlink(string, RenderObject)

Adds a text hyperlink to the current paragraph content.

Declaration

public ParagraphText AddHyperlink(string text, RenderObject renderObject)

Public Function AddHyperlink(text As String, renderObject As RenderObject) As ParagraphText

Parameters

Type	Name	Description
string	text	The text string to add.
RenderObject	renderObject	A RenderObject which is the target of the hyperlink.

Returns

Type	Description
ParagraphText	A ParagraphText object representing the specified text string, associated with the specified hyperlink.

Remarks

This method creates a ParagraphText, initializes it with the specified text, sets the Hyperlink on that object to a C1Hyperlink initialized with renderObject, and adds it to the current collection.

AddHyperlink(string, ParagraphObject)

Adds a text hyperlink to the current paragraph content.

Declaration

public ParagraphText AddHyperlink(string text, ParagraphObject paragraphObject)

Public Function AddHyperlink(text As String, paragraphObject As ParagraphObject) As ParagraphText

Parameters

Type	Name	Description
string	text	The text string to add.
ParagraphObject	paragraphObject	A ParagraphObject which is the target of the hyperlink.

Returns

Type	Description
ParagraphText	A ParagraphText object representing the specified text string, associated with the specified hyperlink.

Remarks

This method creates a ParagraphText, initializes it with the specified text, sets the Hyperlink on that object to a C1Hyperlink initialized with paragraphObject, and adds it to the current collection.

AddHyperlink(Image, string)

Adds an image hyperlink to the current paragraph content.

Declaration

public ParagraphImage AddHyperlink(Image image, string anchorName)

Public Function AddHyperlink(image As Image, anchorName As String) As ParagraphImage

Parameters

Type	Name	Description
Image	image	The image to add.
string	anchorName	The name of the anchor which is the target of the hyperlink.

Returns

Type	Description
ParagraphImage	A ParagraphImage object representing the specified image, associated with the specified hyperlink.

Remarks

This method creates a ParagraphImage, initializes it with the specified image, sets the Hyperlink on that object to a C1Hyperlink initialized with anchorName, and adds it to the current collection.

AddHyperlink(Image, C1LinkTarget)

Adds an image hyperlink to the current paragraph content.

Declaration

public ParagraphImage AddHyperlink(Image image, C1LinkTarget target)

Public Function AddHyperlink(image As Image, target As C1LinkTarget) As ParagraphImage

Parameters

Type	Name	Description
Image	image	The image to add.
C1LinkTarget	target	A C1LinkTarget which is the target of the hyperlink.

Returns

Type	Description
ParagraphImage	A ParagraphImage object representing the specified image, associated with the specified hyperlink.

Remarks

This method creates a ParagraphImage, initializes it with the specified image, sets the Hyperlink on that object to a C1Hyperlink initialized with target, and adds it to the current collection.

AddHyperlink(Image, RenderObject)

Adds an image hyperlink to the current paragraph content.

Declaration

public ParagraphImage AddHyperlink(Image image, RenderObject renderObject)

Public Function AddHyperlink(image As Image, renderObject As RenderObject) As ParagraphImage

Parameters

Type	Name	Description
Image	image	The image to add.
RenderObject	renderObject	A RenderObject which is the target of the hyperlink.

Returns

Type	Description
ParagraphImage	A ParagraphImage object representing the specified image, associated with the specified hyperlink.

Remarks

This method creates a ParagraphImage, initializes it with the specified image, sets the Hyperlink on that object to a C1Hyperlink initialized with renderObject, and adds it to the current collection.

AddHyperlink(Image, ParagraphObject)

Adds an image hyperlink to the current paragraph content.

Declaration

public ParagraphImage AddHyperlink(Image image, ParagraphObject paragraphObject)

Public Function AddHyperlink(image As Image, paragraphObject As ParagraphObject) As ParagraphImage

Parameters

Type	Name	Description
Image	image	The image to add.
ParagraphObject	paragraphObject	A ParagraphObject which is the target of the hyperlink.

Returns

Type	Description
ParagraphImage	A ParagraphImage object representing the specified image, associated with the specified hyperlink.

Remarks

This method creates a ParagraphImage, initializes it with the specified image, sets the Hyperlink on that object to a C1Hyperlink initialized with paragraphObject, and adds it to the current collection.