Class ScriptHelperBase

Base class for the ScriptHelper classes.

Inheritance

System.Object

ScriptHelperBase

Namespace: ImageVault.EPiServer.Common.Helpers

Assembly: ImageVault.EPiServer.Common.dll

Syntax

public abstract class ScriptHelperBase : Object

Constructors

ScriptHelperBase(IEPiServerSettings, IClientFactory, ImageVaultClientOptions)

Initializes a new instance of the ScriptHelperBase class.

Declaration

protected ScriptHelperBase(IEPiServerSettings ePiServerSettings, IClientFactory clientFactory, ImageVaultClientOptions clientOptions)

Parameters

Type	Name	Description
IEPiServerSettings	ePiServerSettings
IClientFactory	clientFactory
ImageVaultClientOptions	clientOptions

Fields

DefaultImage

Gets the DefaultImage of the ScriptHelperBase

Declaration

public const string DefaultImage = "images/propertymedia-default.svg"

Field Value

Type	Description
System.String

OpenImageVaultJsKey

Gets the OpenImageVaultJsKey of the ScriptHelperBase

Declaration

protected const string OpenImageVaultJsKey = "OpenImageVaultScript"

Field Value

Type	Description
System.String

Providername

Gets the Provider name of the ScriptHelperBase

Declaration

protected const string Providername = "ImageVaultEPiServerCMS"

Field Value

Type	Description
System.String

Properties

DefaultIconUrl

Gets the DefaultIconUrl of the ScriptHelper

Declaration

public string DefaultIconUrl { get; }

Property Value

Type	Description
System.String

DefaultMediaUrlBase

Gets the DefaultMediaUrlBase of the ScriptHelper

Declaration

public Uri DefaultMediaUrlBase { get; }

Property Value

Type	Description
System.Uri

EditorUrl

Gets the EditorUrl of the ScriptHelper

Declaration

public string EditorUrl { get; }

Property Value

Type	Description
System.String

EPiServerCommonPath

Gets the EPiServerCommonPath of the ScriptHelper

Declaration

public abstract string EPiServerCommonPath { get; }

Property Value

Type	Description
System.String

ImageVaultCoreProxyUrl

Gets the ImageVaultCoreProxyUrl of the ScriptHelper

Declaration

public Uri ImageVaultCoreProxyUrl { get; }

Property Value

Type	Description
System.Uri

ImageVaultSupportRedirectAfterLogin

Declaration

public bool ImageVaultSupportRedirectAfterLogin { get; set; }

Property Value

Type	Description
System.Boolean

ImageVaultUiAuthUrl

Gets the ImageVaultUiAuthUrl of the ScriptHelper

Declaration

public Uri ImageVaultUiAuthUrl { get; }

Property Value

Type	Description
System.Uri

ImageVaultUiIsExternal

Gets the ImageVaultUiIsExternal of the ScriptHelperBase

Declaration

public bool ImageVaultUiIsExternal { get; }

Property Value

Type	Description
System.Boolean	True if Ui is external (ie not on /ImageVault)

ImageVaultUrl

Gets the ImageVaultUrl of the ScriptHelper

Declaration

public Uri ImageVaultUrl { get; }

Property Value

Type	Description
System.Uri

RequestUrl

Gets the left part of the current request url

Declaration

public Uri RequestUrl { get; }

Property Value

Type	Description
System.Uri

Remarks

We cannot use the SiteUrl of the epi server site directly since we want to keep the url from the request to support multiple website addresses.

Methods

GenerateScriptForSource(String)

Generates a script tag with the supplied src attribute

Declaration

public string GenerateScriptForSource(string relativeScriptPath)

Parameters

Type	Name	Description
System.String	relativeScriptPath	The relative script path (from the vpp path)

Returns

Type	Description
System.String

GenerateStyleLinkForSource(String)

Declaration

public string GenerateStyleLinkForSource(string relativeCssPath)

Parameters

Type	Name	Description
System.String	relativeCssPath

Returns

Type	Description
System.String

GenerateTagForSource(String, String)

Declaration

protected string GenerateTagForSource(string tag, string relativePath)

Parameters

Type	Name	Description
System.String	tag
System.String	relativePath

Returns

Type	Description
System.String

GetImageVaultUiInsertUrl(String)

Gets the Uri for the ImageVaultUi insert dialog TODO: Just open the UI without wrapper

Declaration

public string GetImageVaultUiInsertUrl(string pageLangId)

Parameters

Type	Name	Description
System.String	pageLangId

Returns

Type	Description
System.String

GetImageVaultUiUrl(String)

Gets the Uri to the ImageVaultUI

Declaration

public Uri GetImageVaultUiUrl(string pageLangId)

Parameters

Type	Name	Description
System.String	pageLangId

Returns

Type	Description
System.Uri

GetImageVaultVersion()

Get the version of the ImageVault instance

Declaration

public Version GetImageVaultVersion()

Returns

Type	Description
System.Version

GetRedirectUriForIvAuth(HttpRequest)

Declaration

public Uri GetRedirectUriForIvAuth(HttpRequest request)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Http.HttpRequest	request

Returns

Type	Description
System.Uri

QuoteString(String)

Surrounds the supplied string with single quot characters and escapes the supplied string.

Declaration

public string QuoteString(string value)

Parameters

Type	Name	Description
System.String	value

Returns

Type	Description
System.String

Translate(String)

Declaration

protected abstract string Translate(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.String