ImageReference Class

Definition

Namespace

Sandcastle.Core.ConceptualContent

Assembly

Sandcastle.Core.dll

This represents a conceptual content image that can be used to insert a reference to an image in a topic

public class ImageReference

Inheritance

object

ImageReference

Constructors

ImageReference(string, string)

Constructor

Properties

AlternateText	This is used to get or set the optional alternate text for the image
CopyToMedia	This is used to get or set whether or not to copy the image to the .\Output[HelpFormat]\media folder if it is not referenced in a media link.
DisplayTitle	This read-only property is used to get a title for display (i.e. in the designer)
Filename	This read-only property is used to get the image filename without the path
FullPath	This is used to get or set the full path to the image file
Id	This is used to get or set the unique ID of the image

Methods

ToExternalLink()	Convert the image reference to an <externalLink> element
ToImageLink()	Convert the image reference to an <img> element
ToMediaLink()	Convert the image reference to a <mediaLink> element
ToMediaLinkInline()	Convert the image reference to a <mediaLinkInline> element