Class ResourcePreviewUrlGenerator

Base class of any resource preview URL generator

Inheritance
System.Object
ResourcePreviewUrlGenerator
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: OSGeo.MapGuide.MaestroAPI.Resource.Preview
Assembly: OSGeo.MapGuide.MaestroAPI.dll
Syntax
public abstract class ResourcePreviewUrlGenerator : IResourcePreviewUrlGenerator

Constructors

| Improve this Doc View Source

ResourcePreviewUrlGenerator()

Constructor

Declaration
protected ResourcePreviewUrlGenerator()

Properties

| Improve this Doc View Source

AddDebugWatermark

Gets or sets whether to insert a debugging watermark for generated previews

Declaration
public bool AddDebugWatermark { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

UseAjaxViewer

Gets or sets whether to use the AJAX viewer for previews

Declaration
public bool UseAjaxViewer { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

GenerateFeatureSourcePreviewUrl(IResource, String, Boolean, String)

Generates a preview URL for Feature Sources

Declaration
protected abstract string GenerateFeatureSourcePreviewUrl(IResource res, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IResource res
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GenerateFlexLayoutPreviewUrl(IResource, String, Boolean, String)

Generates a preview URL for Flexible Layouts

Declaration
protected abstract string GenerateFlexLayoutPreviewUrl(IResource res, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IResource res
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GenerateLayerPreviewUrl(IResource, String, Boolean, String)

Generates a preview URL for layer definitions

Declaration
protected abstract string GenerateLayerPreviewUrl(IResource res, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IResource res
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GenerateMapPreviewUrl(IResource, String, Boolean, String)

Generates a preview URL for Map Definitions

Declaration
protected abstract string GenerateMapPreviewUrl(IResource res, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IResource res
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GeneratePreviewUrl(IResource, String, Boolean, String)

Generates the appropriate viewer URL to preview the given resource under the given locale

Declaration
public string GeneratePreviewUrl(IResource res, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IResource res
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GenerateWatermarkPreviewUrl(IWatermarkDefinition, String, Boolean, String)

Generates a preview URL for watermarks

Declaration
protected abstract string GenerateWatermarkPreviewUrl(IWatermarkDefinition watermarkDefinition, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IWatermarkDefinition watermarkDefinition
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GenerateWebLayoutPreviewUrl(IResource, String, Boolean, String)

Generates a preview URL for Web Layouts

Declaration
protected abstract string GenerateWebLayoutPreviewUrl(IResource res, string locale, bool isNew, string sessionID)
Parameters
Type Name Description
IResource res
System.String locale
System.Boolean isNew
System.String sessionID
Returns
Type Description
System.String
| Improve this Doc View Source

GetLocale(String)

Gets the locale

Declaration
protected static string GetLocale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
System.String
| Improve this Doc View Source

IsPreviewableType(String)

Indicates if the given resource type is previewable

Declaration
public abstract bool IsPreviewableType(string resourceType)
Parameters
Type Name Description
System.String resourceType
Returns
Type Description
System.Boolean

Implements