Class ExtensionMethods

Extension method class

Inheritance

System.Object

ExtensionMethods

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.ObjectModels.ApplicationDefinition

Assembly: OSGeo.MapGuide.ObjectModels.dll

Syntax

public static class ExtensionMethods

Methods

| Improve this Doc View Source

CreateExtensionElement(IExtensibleElement, String)

Creates an extension element for the given extensible element

Declaration

public static XmlElement CreateExtensionElement(this IExtensibleElement ext, string name)

Parameters

Type	Name	Description
IExtensibleElement	ext
System.String	name

Returns

Type	Description
System.Xml.XmlElement

| Improve this Doc View Source

FindContainer(IApplicationDefinitionContainerInfoSet, String)

Gets a specific container info by type

Declaration

public static IApplicationDefinitionContainerInfo FindContainer(this IApplicationDefinitionContainerInfoSet set, string name)

Parameters

Type	Name	Description
IApplicationDefinitionContainerInfoSet	set
System.String	name

Returns

Type	Description
IApplicationDefinitionContainerInfo

| Improve this Doc View Source

FindElementByName(XmlElement[], String)

Returns a System.Xml.XmlElement whose name matches the specified name

Declaration

public static XmlElement FindElementByName(this XmlElement[] elements, string name)

Parameters

Type	Name	Description
System.Xml.XmlElement[]	elements
System.String	name

Returns

Type	Description
System.Xml.XmlElement

| Improve this Doc View Source

FindTemplate(IApplicationDefinitionTemplateInfoSet, String)

Gets information for the named template

Declaration

public static IApplicationDefinitionTemplateInfo FindTemplate(this IApplicationDefinitionTemplateInfoSet set, string name)

Parameters

Type	Name	Description
IApplicationDefinitionTemplateInfoSet	set
System.String	name

Returns

Type	Description
IApplicationDefinitionTemplateInfo

| Improve this Doc View Source

FindWidget(IApplicationDefinition, String)

Gets the widget of the specified name

Declaration

public static IWidget FindWidget(this IApplicationDefinition appDef, string name)

Parameters

Type	Name	Description
IApplicationDefinition	appDef
System.String	name

Returns

Type	Description
IWidget

| Improve this Doc View Source

FindWidget(IApplicationDefinitionWidgetInfoSet, String)

Gets a specific Widget Info by name

Declaration

public static IWidgetInfo FindWidget(this IApplicationDefinitionWidgetInfoSet set, string name)

Parameters

Type	Name	Description
IApplicationDefinitionWidgetInfoSet	set
System.String	name

Returns

Type	Description
IWidgetInfo

| Improve this Doc View Source

GetAllValues(IExtensibleElement)

Gets all the properties in this extensible element

Declaration

public static NameValueCollection GetAllValues(this IExtensibleElement ext)

Parameters

Type	Name	Description
IExtensibleElement	ext

Returns

Type	Description
System.Collections.Specialized.NameValueCollection

| Improve this Doc View Source

GetFirstWidgetSet(IApplicationDefinition)

Gets the first widget set of this application definition.

Declaration

public static IWidgetSet GetFirstWidgetSet(this IApplicationDefinition appDef)

Parameters

Type	Name	Description
IApplicationDefinition	appDef

Returns

Type	Description
IWidgetSet

| Improve this Doc View Source

GetGroupById(IMapSet, String)

Gets the specified map group by its id

Declaration

public static IMapGroup GetGroupById(this IMapSet set, string id)

Parameters

Type	Name	Description
IMapSet	set
System.String	id

Returns

Type	Description
IMapGroup

| Improve this Doc View Source

GetMapDefinition(IMap)

Set the map definition id

Declaration

public static string GetMapDefinition(this IMap map)

Parameters

Type	Name	Description
IMap	map

Returns

Type	Description
System.String

| Improve this Doc View Source

GetNames(IExtensibleElement)

Gets the names of all properties of this extensible element

Declaration

public static string[] GetNames(this IExtensibleElement ext)

Parameters

Type	Name	Description
IExtensibleElement	ext

Returns

Type	Description
System.String[]

| Improve this Doc View Source

GetTemplateName(IApplicationDefinition)

Gets the name of the fusion template

Declaration

public static string GetTemplateName(this IApplicationDefinition appDef)

Parameters

Type	Name	Description
IApplicationDefinition	appDef

Returns

Type	Description
System.String

| Improve this Doc View Source

GetValue(IExtensibleElement, String)

Gets the value of a property in this extensible element. If none exists, an empty string is returned

Declaration

public static string GetValue(this IExtensibleElement ext, string name)

Parameters

Type	Name	Description
IExtensibleElement	ext
System.String	name

Returns

Type	Description
System.String

| Improve this Doc View Source

GetXYZUrls(IMap)

Gets the configured XYZ urls for the given IMap extension element

Declaration

public static IEnumerable<string> GetXYZUrls(this IMap map)

Parameters

Type	Name	Description
IMap	map

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

| Improve this Doc View Source

RemoveWidget(IApplicationDefinition, String, Boolean)

Removes the specified widget from this

Declaration

public static void RemoveWidget(this IApplicationDefinition appDef, string widgetName, bool deleteReferences)

Parameters

Type	Name	Description
IApplicationDefinition	appDef	The app definition.
System.String	widgetName	Name of the widget to remove.
System.Boolean	deleteReferences	if set to `true` [deletes any references to the widget to be deleted].

| Improve this Doc View Source

SetAllValues(IExtensibleElement, NameValueCollection)

Replace the values of all properties in this extensible element with the values provided

Declaration

public static void SetAllValues(this IExtensibleElement ext, NameValueCollection values)

Parameters

Type	Name	Description
IExtensibleElement	ext
System.Collections.Specialized.NameValueCollection	values

| Improve this Doc View Source

SetMapDefinition(IMap, String)

Gets the map definition id

Declaration

public static void SetMapDefinition(this IMap map, string mapDefId)

Parameters

Type	Name	Description
IMap	map
System.String	mapDefId

| Improve this Doc View Source

SetSubjectOrExternalLayerProperties(IExtensibleElement, IDictionary<String, Object>)

Declaration

public static void SetSubjectOrExternalLayerProperties(this IExtensibleElement ext, IDictionary<string, object> props)

Parameters

Type	Name	Description
IExtensibleElement	ext
System.Collections.Generic.IDictionary<System.String, System.Object>	props

| Improve this Doc View Source

SetValue(IExtensibleElement, String, String)

Sets the value of a property in this extensible element.

Declaration

public static void SetValue(this IExtensibleElement ext, string name, string value)

Parameters

Type	Name	Description
IExtensibleElement	ext
System.String	name
System.String	value

| Improve this Doc View Source

SetXYZUrls(IMap, String[])

Sets the XYZ urls for the given IMap extension element

Declaration

public static void SetXYZUrls(this IMap map, params string[] urls)

Parameters

Type	Name	Description
IMap	map
System.String[]	urls

| Improve this Doc View Source

WidgetNameExists(IApplicationDefinition, String)

Gets whether a widget with the specified name already exists

Declaration

public static bool WidgetNameExists(this IApplicationDefinition appDef, string name)

Parameters

Type	Name	Description
IApplicationDefinition	appDef
System.String	name

Returns

Type	Description
System.Boolean