Class ImageVaultReference
Class to define a reference to an ImageVault asset
Inheritance
Namespace: ImageVault.EPiServer
Assembly: ImageVault.EPiServer.dll
Syntax
public class ImageVaultReference : ObjectConstructors
ImageVaultReference()
Declaration
public ImageVaultReference()Properties
Attribute
Get/Sets the Attribute of the ImageVaultReference
Declaration
public HtmlAttribute Attribute { get; set; }Property Value
| Type | Description |
|---|---|
| HtmlAgilityPack.HtmlAttribute | The attribute where the value was found (or null if not used) |
Embed
If the reference should be embedded
Declaration
public bool Embed { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
MediaKey
Get/Sets the MediaKey of the ImageVaultReference
Declaration
public string MediaKey { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The media key of the reference |
OptionalFlags
Get/Sets the OptionalFlags of the ImageVaultReference
Declaration
public string OptionalFlags { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | Any optional value |
Post
Get/Sets the Post of the ImageVaultReference
Declaration
public string Post { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The value after the media key |
Pre
Get/Sets the Pre of the ImageVaultReference
Declaration
public string Pre { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The value before the media marker (/PublishedMedia/ or /Media/) |
Published
Get/Sets the Published of the ImageVaultReference
Declaration
public bool Published { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | True if the reference is a published item. False if it is an internal. |
Methods
CreatePublishedUrl(String, String)
Creates a published url using the supplied key
Declaration
public string CreatePublishedUrl(string publishedKey, string defaultPublishedMediaUrlBase)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | publishedKey | |
| System.String | defaultPublishedMediaUrlBase | The DefaultPublishedMediaUrlBase to use |
Returns
| Type | Description |
|---|---|
| System.String |
Parse(HtmlAttribute)
Parses the supplied attribute for a iv asset link
Declaration
public static ImageVaultReference Parse(HtmlAttribute attribute)Parameters
| Type | Name | Description |
|---|---|---|
| HtmlAgilityPack.HtmlAttribute | attribute |
Returns
| Type | Description |
|---|---|
| ImageVaultReference |
Parse(String)
Declaration
public static ImageVaultReference Parse(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
| Type | Description |
|---|---|
| ImageVaultReference |