Interface IWebLayout

The Web Layout

Inherited Members

IResource.ValidatingSchema

IResource.ResourceID

IResource.ResourceType

IResource.Serialize()

IResource.IsStronglyTyped

IVersionedEntity.ResourceVersion

System.ICloneable.Clone()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: OSGeo.MapGuide.ObjectModels.WebLayout

Assembly: OSGeo.MapGuide.ObjectModels.dll

Syntax

public interface IWebLayout : IResource, IVersionedEntity, ICloneable, INotifyPropertyChanged

Properties

| Improve this Doc View Source

CommandSet

Gets the command set.

Declaration

ICommandSet CommandSet { get; }

Property Value

Type	Description
ICommandSet	The command set.

| Improve this Doc View Source

ContextMenu

Gets the context menu.

Declaration

IContextMenu ContextMenu { get; }

Property Value

Type	Description
IContextMenu	The context menu.

| Improve this Doc View Source

InformationPane

Gets the information pane.

Declaration

IInformationPane InformationPane { get; }

Property Value

Type	Description
IInformationPane	The information pane.

| Improve this Doc View Source

Map

Gets the map.

Declaration

IMap Map { get; }

Property Value

Type	Description
IMap	The map.

| Improve this Doc View Source

StatusBar

Gets the status bar.

Declaration

IStatusBar StatusBar { get; }

Property Value

Type	Description
IStatusBar	The status bar.

| Improve this Doc View Source

TaskPane

Gets the task pane.

Declaration

ITaskPane TaskPane { get; }

Property Value

Type	Description
ITaskPane	The task pane.

| Improve this Doc View Source

Title

Gets or sets the title.

Declaration

string Title { get; set; }

Property Value

Type	Description
System.String	The title.

| Improve this Doc View Source

ToolBar

Gets the tool bar.

Declaration

IToolbar ToolBar { get; }

Property Value

Type	Description
IToolbar	The tool bar.

| Improve this Doc View Source

ZoomControl

Gets the zoom control.

Declaration

IZoomControl ZoomControl { get; }

Property Value

Type	Description
IZoomControl	The zoom control.

Methods

| Improve this Doc View Source

CreateBasicCommand(String, String, String, String, TargetViewerType, BasicCommandActionType)

Creates the basic command.

Declaration

IBasicCommand CreateBasicCommand(string label, string tooltip, string description, string iconName, TargetViewerType targets, BasicCommandActionType action)

Parameters

Type	Name	Description
System.String	label	The label.
System.String	tooltip	The tooltip.
System.String	description	The description.
System.String	iconName	Name of the icon.
TargetViewerType	targets	The targets.
BasicCommandActionType	action	The action.

Returns

Type	Description
IBasicCommand	The basic command

| Improve this Doc View Source

CreateCommandItem(String)

Creates the command item.

Declaration

ICommandItem CreateCommandItem(string cmdName)

Parameters

Type	Name	Description
System.String	cmdName	Name of the command.

Returns

Type	Description
ICommandItem	The command item

| Improve this Doc View Source

CreateDefaultView()

Creates the default view.

Declaration

IMapView CreateDefaultView()

Returns

Type	Description
IMapView	The default view

| Improve this Doc View Source

CreateFlyout(String, String, String, String, String, IUIItem[])

Creates the flyout.

Declaration

IFlyoutItem CreateFlyout(string label, string tooltip, string description, string imageUrl, string disabledImageUrl, params IUIItem[] subItems)

Parameters

Type	Name	Description
System.String	label	The label.
System.String	tooltip	The tooltip.
System.String	description	The description.
System.String	imageUrl	The image URL.
System.String	disabledImageUrl	The disabled image URL.
IUIItem[]	subItems	The sub items.

Returns

Type	Description
IFlyoutItem	The flyout

| Improve this Doc View Source

CreateInvokeScriptCommand()

Creates the invoke script command.

Declaration

IInvokeScriptCommand CreateInvokeScriptCommand()

Returns

Type	Description
IInvokeScriptCommand	The invoke script command

| Improve this Doc View Source

CreateInvokeUrlCommand()

Creates the invoke URL command.

Declaration

IInvokeUrlCommand CreateInvokeUrlCommand()

Returns

Type	Description
IInvokeUrlCommand	The invoke URL command

| Improve this Doc View Source

CreateSearchCommand()

Creates the search command.

Declaration

ISearchCommand CreateSearchCommand()

Returns

Type	Description
ISearchCommand	The search command

| Improve this Doc View Source

CreateSeparator()

Creates the separator.

Declaration

ISeparatorItem CreateSeparator()

Returns

Type	Description
ISeparatorItem	The separator

| Improve this Doc View Source

CreateTargetedCommand<T>(String, String, String, String, String, TargetViewerType, TargetType, String)

Creates the targeted command.

Declaration

T CreateTargetedCommand<T>(string name, string label, string tooltip, string description, string iconName, TargetViewerType targets, TargetType target, string targetFrame)
    where T : ITargetedCommand, new()

Parameters

Type	Name	Description
System.String	name	The name.
System.String	label	The label.
System.String	tooltip	The tooltip.
System.String	description	The description.
System.String	iconName	Name of the icon.
TargetViewerType	targets	The targets.
TargetType	target	The target.
System.String	targetFrame	The target frame.

Returns

Type	Description
T	The targeted command

Type Parameters

Name	Description
T

| Improve this Doc View Source

ExportCustomCommands(String, String[])

Exports the specified commands to the specified file

Declaration

void ExportCustomCommands(string file, string[] cmdNames)

Parameters

Type	Name	Description
System.String	file	The file to export to
System.String[]	cmdNames	The specified commands

| Improve this Doc View Source

FindCommand(String, IMenu)

Finds the command by its name in the specified menu.

Declaration

bool FindCommand(string name, IMenu menu)

Parameters

Type	Name	Description
System.String	name	The name.
IMenu	menu	The menu.

Returns

Type	Description
System.Boolean	True if found. False otherwise

| Improve this Doc View Source

GetCommandByName(String)

Gets a command by its name

Declaration

ICommand GetCommandByName(string cmdName)

Parameters

Type	Name	Description
System.String	cmdName	Name of the command.

Returns

Type	Description
ICommand	The command

| Improve this Doc View Source

GetCustomCommands()

Gets the custom commands.

Declaration

IEnumerable<ICommand> GetCustomCommands()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ICommand>	The enumerable of commands

| Improve this Doc View Source

ImportCustomCommands(String)

Imports commands from the specified file

Declaration

ImportedCommandResult[] ImportCustomCommands(string file)

Parameters

Type	Name	Description
System.String	file	The file to import from

Returns

Type	Description
ImportedCommandResult[]	The imported commands

| Improve this Doc View Source

IsCommandReferenced(String, out WebLayoutRegion[])

Determines whether the specified command name is referenced in any regions

Declaration

bool IsCommandReferenced(string name, out WebLayoutRegion[] region)

Parameters

Type	Name	Description
System.String	name	The name.
WebLayoutRegion[]	region	The region.

Returns

Type	Description
System.Boolean	True if referenced. False otherwise

| Improve this Doc View Source

RemoveAllReferences(String)

Removes all references to the specified command name

Declaration

int RemoveAllReferences(string cmdName)

Parameters

Type	Name	Description
System.String	cmdName	Name of the command.

Returns

Type	Description
System.Int32	The number removed

Extension Methods

ExtensionMethods.CopyResourceDataTo(IResource, IServerConnection, IResource)

ExtensionMethods.CopyResourceDataTo(IResource, IServerConnection, String)

ResourceExtensions.SerializeToStream(IResource)

ResourceExtensions.GetResourceTypeDescriptor(IResource)