ImageReference Class

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

Definition

Namespace: Sandcastle.Core.ConceptualContent
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0

public class ImageReference

Public Class ImageReference

public ref class ImageReference

type ImageReference = class end

Constructor

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

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ToExternalLink	Convert the image reference to an <externalLink> element
ToImageLink	Convert the image reference to an <img> element
ToMarkdownLink	Convert the image reference to a Markdown image link
ToMediaLink	Convert the image reference to a <mediaLink> element
ToMediaLinkInline	Convert the image reference to a <mediaLinkInline> element
ToString	Returns a string that represents the current object. (Inherited from Object)