MGSymbolAttr.setSymbol   Go to object model Go to parent topic Go to previous topic Go to next topic

Syntax

boolean setSymbol(String symbol)

Description

Sets the symbol to be used as the symbol attribute.

If the specified symbol contains bitmaps, and the current rotation angle is non-zero, the symbol will be set, and the rotation angle will be set to zero.

Currently, the API can only access symbols in the API symbol list. The API symbol list is an MWF or EMF file containing a small set of predefined symbols. You can use the Autodesk MapGuide user interface to create additional API symbols. For more information, refer to "Adding Symbols for Use with the Autodesk MapGuide Viewer API" and "API Symbol Manager dialog box" in the MapGuide Help.

Parameters

symbol - The symbol name.

Returns

boolean - Returns True if successful; otherwise, returns False.

Error Codes

-1 (busy)

-3 (illegal argument)

-17 (can't rotate symbols with bitmaps): This return code is acts as a warning rather than an error.

See Also

getSymbol, Symbol