MGDwgDataSources.setUrlColumn   Go to object model Go to parent topic Go to previous topic Go to next topic

Syntax

boolean setUrlColumn(string column) 

Description

Sets the name of the column that contains the URL associated with each map feature.

This enables the user to go to a Web page that is related to a map feature simply by double-clicking that feature. Typically, you store HTTP URLs in this column, but you could also specify commands with other protocols, such as FTP URLs, or even JavaScript commands. Use caution, however, with non-standard protocols such as Javascript:, as not all browsers support them.

If this method is successful, it automatically sets the layer's rebuild flag to True. See setRebuild for more information.

Note that this method does not work during a busy state. For additional information about the busy state, refer to "Handling Busy State and Map Refresh" in the Autodesk MapGuide Developer's Guide.

Parameters

column - The name that you want the URL column to be set to.

Returns

boolean - Returns True if successful; otherwise returns False.

Error Codes

-1 (busy)

Example

This code is designed to work with the 1stfloorplanEx6.mwf file used by the Filter DWG Layers example:

function setProperties()
{
   // Get the map and selected features
   var map = getMap();
   var mapSel = map.getSelection();
   // Use the single map layer Floor Plan
   var mapLayer = map.getMapLayer("Floor Plan");
   // Get DWG data source object for the layer
   var mapLayerSetup = mapLayer.getLayerSetup();
   var dwgMapLayerDataSource = mapLayerSetup.getDwgDataSources();
   dwgMapLayerDataSource.setUrlColumn("newUrlColumn");

}

See Also

getUrlColumn, UrlColumn