API Reference > Dgn Extension Classes > ExDgCommandContext Class > ExDgCommandContext Methods > ExDgCommandContext::getColor Method
ExDgCommandContext::getColor Method
Collapse All
Syntax
C++
OdDgCmColor getColor(const OdString& prompt, int options = OdEd::kInpDefault, const OdDgCmColor* pDefVal = 0, const OdString& keywordList = OdString::kEmpty, OdEdColorTracker* pTracker = 0);
Parameters
Parameters 
Description 
const OdString& prompt 
[in] Message displayed to prompt the user.  
int options = OdEd::kInpDefault 
[in] Combination of OdEd::GetPointOptions enum values.  
OdEdColorTracker* pTracker = 0 
[in] Pointer to a User IO tracker. 
pDefaultValue 
[in] Pointer to a default value to return if an empty string is received as input.  
keywords 
[in] Keyword string.  
Description

Returns user input of a color. 

 

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input. 

If prompt is an empty string, a default prompt string is used.

Group
Copyright © 2002–2020. Open Design Alliance. All rights reserved.
Send feedback about this topic