Functions

Functions

StatusInt mdlDialog_textGetRange (WChar *minimumP, WChar *maximumP, RawItemHdr *textP)
 Retrieves the minimum and maximum value strings from the Text item specified by textP. More...
 
StatusInt mdlDialog_textSetRange (RawItemHdr *textP, WCharCP minimumP, WCharCP maximumP)
 Sets the minimum and maximum value strings for the Text item specified by textP. More...
 
void mdlDialog_textGetBasicText (BasicText **bTextPP, RawItemHdr *textP)
 Gets the internal BasicText item from a MSDialog Text item. More...
 
StatusInt mdlDialog_textGetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, int *maxSizeP, WChar *formatToDisplayP, WChar *formatToInternalP, WChar *minimumP, WChar *maximumP, UInt32 *maskP, UShort *attributesP, long *labelAboveP, RawItemHdr *textP)
 Gets information on the attributes of a Text item. More...
 
StatusInt mdlDialog_textSetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, int *maxSizeP, WCharCP formatToDisplayP, WCharCP formatToInternalP, WCharCP minimumP, WCharCP maximumP, UInt32 *maskP, UShort *attributesP, long *labelAboveP, bool redraw, RawItemHdr *textP)
 Sets information on the attributes of a Text item. More...
 
StatusInt mdlDialog_textSetSubEditor (RawItemHdr *textP, bool bSubEditor, RawItemHdr *ownerRiP)
 Enables the specified Text item as a sub-editor. More...
 
StatusInt mdlDialog_textSetWatermarkText (RawItemHdr *textP, WCharCP watermarkText)
 Sets the "watermark" text to display inside a text item when empty. More...
 

Detailed Description

Function Documentation

void mdlDialog_textGetBasicText ( BasicText **  bTextPP,
RawItemHdr textP 
)

Gets the internal BasicText item from a MSDialog Text item.

Parameters
[out]bTextPPis a memory location that will receive a pointer to the text from the dialog item.
[out]textPis a pointer to the dialog Text item that holds the text.
See also
mdlDialog_mlTextGetBasicText
StatusInt mdlDialog_textGetInfo ( CommandNumber *  commandNumberP,
UInt32 commandSourceP,
int *  maxSizeP,
WChar *  formatToDisplayP,
WChar *  formatToInternalP,
WChar *  minimumP,
WChar *  maximumP,
UInt32 maskP,
UShort attributesP,
long *  labelAboveP,
RawItemHdr textP 
)

Gets information on the attributes of a Text item.

See the discussion of the Text item resource for further information on the information associated with Text items. For all of the pointer parameters, NULL indicates the field is not desired.

Parameters
[out]commandNumberPpoints to a variable containing the command number associated with the Text item.
[out]commandSourcePpoints to a variable indicating the source of the command, typically LCMD indicating a command from the current MDL application, or MCMD, indicating a MicroStation command.
[out]maxSizePpoints to a variable indicating the maximum allowable size of the text string that can be contained by the item, up to 32K characters.
[out]formatToDisplayPpoints to a sprintf format string to convert the value of the variable associated with the Text item into a displayable string.
[out]formatToInternalPpoints to a sscanf format string to convert from the Text item's string value to the format expected by the varaible associated with the Text item.
[out]minimumPpoints to a string that contains the minimum value of Text item.
[out]maximumPpoints to a string that contains maximum value of Text item.
[out]maskPpoints to a variable indicating which bits of the associated variable may be set if the variable is an integer. Can be NOMASK, which is equivalent to 0xFFFFFFFF.
[out]attributesPpoints to a variable that specifies Text item characteristics, such as TEXT_CONCAT, TEXT_NOCONCAT and TEXT_READONLY.
[out]labelAbovePpoints to a variable containing the labelAbove field.
[in]textPpoints to the RawItemHdr of the Text item to get or set information on.
Returns
SUCCESS, or non-zero value if there is an error.
See also
mdlDialog_textSetInfo
StatusInt mdlDialog_textGetRange ( WChar *  minimumP,
WChar *  maximumP,
RawItemHdr textP 
)

Retrieves the minimum and maximum value strings from the Text item specified by textP.

Parameters
[out]minimumPminumum value string
[out]maximumPmaximum value string
[in]textPText item
Remarks
Either of the parameters minimumP or maximumP can be NULL. The corresponding value will not be retrieved or set.
Returns
SUCCESS, or non-zero value if an error occurs. This means that textP does not point to a Text item.
See also
mdlDialog_testSetRange
StatusInt mdlDialog_textSetInfo ( CommandNumber *  commandNumberP,
UInt32 commandSourceP,
int *  maxSizeP,
WCharCP  formatToDisplayP,
WCharCP  formatToInternalP,
WCharCP  minimumP,
WCharCP  maximumP,
UInt32 maskP,
UShort attributesP,
long *  labelAboveP,
bool  redraw,
RawItemHdr textP 
)

Sets information on the attributes of a Text item.

See the discussion of the Text item resource for further information on the information associated with Text items. For all of the pointer parameters, NULL indicates the field should not be modified.

Parameters
[in]commandNumberPpoints to a variable containing the command number associated with the Text item.
[in]commandSourcePpoints to a variable indicating the source of the command, typically LCMD indicating a command from the current MDL application, or MCMD, indicating a MicroStation command.
[in]maxSizePpoints to a variable indicating the maximum allowable size of the text string that can be contained by the item, up to 32K characters.
[in]formatToDisplayPpoints to a sprintf format string to convert the value of the variable associated with the Text item into a displayable string.
[in]formatToInternalPpoints to a sscanf format string to convert from the Text item's string value to the format expected by the varaible associated with the Text item.
[in]minimumPpoints to a string that contains the minimum value of Text item.
[in]maximumPpoints to a string that contains maximum value of Text item.
[in]maskPpoints to a variable indicating which bits of the associated variable may be set if the variable is an integer. Can be NOMASK, which is equivalent to 0xFFFFFFFF.
[in]attributesPpoints to a variable that specifies Text item characteristics, such as TEXT_CONCAT, TEXT_NOCONCAT and TEXT_READONLY.
[in]labelAbovePpoints to a variable containing the labelAbove field.
[in]redrawIf redraw is true, the item should be redrawn after the attributes are set.
[in]textPpoints to the RawItemHdr of the Text item to get or set information on.
Returns
SUCCESS, or non-zero value if there is an error.
See also
mdlDialog_textSetInfo
StatusInt mdlDialog_textSetRange ( RawItemHdr textP,
WCharCP  minimumP,
WCharCP  maximumP 
)

Sets the minimum and maximum value strings for the Text item specified by textP.

Parameters
[in]textPText item
[in]minimumPnew minumum value string
[in]maximumPnew maximum value string
Remarks
Either of the parameters minimumP or maximumP can be NULL. The corresponding value will not be retrieved or set.
Returns
SUCCESS, or non-zero value if an error occurs. This means that textP does not point to a Text item.
See also
mdlDialog_textGetRange
StatusInt mdlDialog_textSetSubEditor ( RawItemHdr textP,
bool  bSubEditor,
RawItemHdr ownerRiP 
)

Enables the specified Text item as a sub-editor.

Parameters
[in]textPpoints to the Text item to enable as a sub-editor
[in]bSubEditortrue if the Text item is to be enabled as a sub-editor, otherwise, false
[in]ownerRiPthe raw item pointer of the Text item owner
Returns
SUCCESS, or non-zero value if there is an error.
StatusInt mdlDialog_textSetWatermarkText ( RawItemHdr textP,
WCharCP  watermarkText 
)

Sets the "watermark" text to display inside a text item when empty.

The text draws dimmed and italic.

Parameters
[in]textPPoints to the Text item to set empty display text for.
watermarkTextText to display inside a text item when empty
Returns
SUCCESS, or non-zero value if there is an error.

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.