Interface IBaseLoadProcedure

Base type of all load procedures. All Load Procedures at the minimum require the following information:

A list of source files.
The root path to load into
The folder where spatial data sources will be created [optional, but useless if not specified]
The folder where layers will be created [optional. dependent on #3]

Once initialized, load procedures can be executed via OSGeo.MapGuide.MaestroAPI.MgServerConnectionBase.ExecuteLoadProcedure(OSGeo.MapGuide.ObjectModels.LoadProcedure.ILoadProcedure,OSGeo.MapGuide.MaestroAPI.LengthyOperationProgressCallBack,System.Boolean) method

Because Load Procedures are also resources, they can be saved into the library repository via the OSGeo.MapGuide.MaestroAPI.Services.IResourceService.SaveResource(IResourceHandle) method and retrieved from the repository via the GetResource(String) method

Inherited Members

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: OSGeo.MapGuide.ObjectModels.LoadProcedure

Assembly: OSGeo.MapGuide.ObjectModels.dll

Syntax

public interface IBaseLoadProcedure : INotifyPropertyChanged

Properties

| Improve this Doc View Source

CoordinateSystem

Gets or sets the coordinate system to use if none found in the source file.

Declaration

string CoordinateSystem { get; set; }

Property Value

Type	Description
System.String	The coordinate system.

| Improve this Doc View Source

GenerateLayers

Gets or sets a value indicating whether to create a layer for each spatial data source that is created. This will be created in the LayersFolder under the LayersPath

Declaration

bool GenerateLayers { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [generate layers]; otherwise, `false`.

| Improve this Doc View Source

GenerateMaps

Gets or sets the generate maps. Not supported by Maestro

Declaration

bool? GenerateMaps { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	The generate maps.

| Improve this Doc View Source

GenerateSpatialDataSources

Gets or sets a value indicating whether to create a spatial data source for each source file. The spatial data sources will be created under the SpatialDataSourcesFolder under the SpatialDataSourcesPath

Declaration

bool GenerateSpatialDataSources { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [generate spatial data sources]; otherwise, `false`.

| Improve this Doc View Source

GenerateSymbolLibraries

Not supported by Maestro

Declaration

bool? GenerateSymbolLibraries { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

LayersFolder

Gets or sets the layers folder.

Declaration

string LayersFolder { get; set; }

Property Value

Type	Description
System.String	The layers folder.

| Improve this Doc View Source

LayersPath

Gets or sets the layers path.

Declaration

string LayersPath { get; set; }

Property Value

Type	Description
System.String	The layers path.

| Improve this Doc View Source

MapsFolder

Gets or sets the maps folder. Not supported by Maestro

Declaration

string MapsFolder { get; set; }

Property Value

Type	Description
System.String	The maps folder.

| Improve this Doc View Source

MapsPath

Gets or sets the maps path. Not supported by Maestro

Declaration

string MapsPath { get; set; }

Property Value

Type	Description
System.String	The maps path.

| Improve this Doc View Source

ResourceId

Gets or sets the resource id that were created as part of executing this load procedure

Declaration

BindingList<string> ResourceId { get; set; }

Property Value

Type	Description
System.ComponentModel.BindingList<System.String>	The resource id.

| Improve this Doc View Source

RootPath

Gets or sets the root path.

Declaration

string RootPath { get; set; }

Property Value

Type	Description
System.String	The root path.

| Improve this Doc View Source

SourceFile

Gets the source files.

Declaration

BindingList<string> SourceFile { get; }

Property Value

Type	Description
System.ComponentModel.BindingList<System.String>	The source files.

| Improve this Doc View Source

SpatialDataSourcesFolder

Gets or sets the spatial data sources folder.

Declaration

string SpatialDataSourcesFolder { get; set; }

Property Value

Type	Description
System.String	The spatial data sources folder.

| Improve this Doc View Source

SpatialDataSourcesPath

Gets or sets the spatial data sources path.

Declaration

string SpatialDataSourcesPath { get; set; }

Property Value

Type	Description
System.String	The spatial data sources path.

| Improve this Doc View Source

SymbolLibrariesFolder

Not supported by Maestro

Declaration

string SymbolLibrariesFolder { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SymbolLibrariesPath

Not supported by Maestro

Declaration

string SymbolLibrariesPath { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Type

Gets the type.

Declaration

LoadType Type { get; }

Property Value

Type	Description
LoadType	The type.

Methods

| Improve this Doc View Source

AddFile(String)

Adds the file.

Declaration

void AddFile(string file)

Parameters

Type	Name	Description
System.String	file	The file.

| Improve this Doc View Source

RemoveFile(String)

Removes the file.

Declaration

void RemoveFile(string file)

Parameters

Type	Name	Description
System.String	file	The file.

Extension Methods

BaseLoadProcedureExtensions.AddFiles(IBaseLoadProcedure, IEnumerable<String>)