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

Syntax

boolean setNameColumn(string column) 

Description

Sets the name of the column that contains the name for each map feature.

The feature’s name appears in a MapTip and in the status bar when the user pauses the mouse pointer over the feature.

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 name column to be set to.

Returns

boolean - Returns True if successful; otherwise, returns False. If successful, sets the layer's rebuild flag to True.

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.setNameColumn("newNameColumn");
}

See Also

getNameColumn, NameColumn