CurrentSymbol() function - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

Purpose

Returns the Symbol style currently in use. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

CurrentSymbol()

Return Value

Symbol

Description

The CurrentSymbol() function returns the current symbol style. This is the style displayed in the Symbol Style dialog box. MapInfo Pro assigns the current Symbol style to any point objects drawn by the user. If a MapBasic program creates a point object through a Create Point statement, but the statement does not include a Symbol clause, the object will be assigned the current Symbol value.

The return value of the CurrentSymbol() function can be assigned to a Symbol variable, or may be used as a parameter within a statement that takes a Symbol clause as a parameter (such as Set Map statement or Shade statement).

To extract specific attributes of the Symbol style (such as the color), call the StyleAttr() function. For more information about Symbol settings, see Symbol clause.

Example

Dim sym_user_symbol As Symbol
sym_user_symbol = CurrentSymbol() 

See Also:

MakeSymbol() function, Set Style statement, StyleAttr() function, Symbol clause