ImageReference Class

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

Inheritance Hierarchy

SystemObject
SandcastleBuilder.Utils.ConceptualContentImageReference

Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

public class ImageReference

Public Class ImageReference

public ref class ImageReference

type ImageReference =  class end

The ImageReference type exposes the following members.

Constructors

	Name	Description
	ImageReference	Constructor

Methods

	Name	Description
	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 a hash function for a particular type. (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.
	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.)

Properties

	Name	Description
	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).
	FileItem	This is used to get the file item associated with the image reference.
	Filename	This is used to get the image filename
	FullPath	This is used to get the full path to the image file
	Id	This is used to get the unique ID of the image

Remarks

This class is serializable so that it can be copied to the clipboard.