get_interative_selection_range

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Included
9 Reference

Description

Gets the selected range string

Syntax

string get_interative_selection_range( DWORD dwOptions = 0, HWND hWndParent = NULL, LPCSTR lpcszDefaultText = NULL, LPCSTR lpcszTitle = NULL, DWORD dwFlyoutOptions = 0, InterRangeType nRangeType = InterRangeType_Range, TreeNode * ptrInput = NULL, int nNodeID = ONODETYPE_INVALID )

Parameters

dwOptions: [input] INTERACTIVECONTROLOPTIONS
hWndParent: [input] Parent window
lpcszDefaultText: [input] Initial value of the DataRange
lpcszTitle: [input] Interactive control's title
dwFlyoutOptions: [input] if dwFlyoutOptions = INTERACTIVE_CONTROL_FLYOUT_OPTIONS_NO_DATA_SELECTOR, no data selector when you select a plot
nRangeType: [input] Range type, can be one of the InterRangeType option; typedef enum {; InterRangeType_Range = 0,; InterRangeType_XYRange,; InterRangeType_XYZRange,; } InterRangeType;
ptrInput: [output] Node of the interactive control
nNodeID: [input] Use nNodeID to restrict the selected range type, can be one of the followings; ONODETYPE_INVALID, ONODETYPE_WORKSHEET, ONODETYPE_MATRIXLAYER, ONODETYPE_GRAPHLAYER, ONODETYPE_WKSPAGE, ONODETYPE_MATRIXPAGE, ONODETYPE_GRAPHPAGE

Return

Return the selected range string

Examples

EX1

void get_interative_selection_range_ex1()
{
    DWORD dwOptions = ICOPT_LABEL_AREA_ONLY;
    Window wnd = GetWindow();
    string strRange = get_interative_selection_range(dwOptions, wnd.GetSafeHwnd(), "", "Select some label rows");
    out_str(strRange);
}

EX2

void get_interative_selection_range_ex2()
{
    //set dwFlyoutOptions to 0 or INTERACTIVE_CONTROL_FLYOUT_OPTIONS_NO_DATA_SELECTOR to see the difference
    DWORD dwFlyoutOptions = 0;
    int nRangeType = InterRangeType_XYRange;
    Window wnd = GetWindow();
    string strRange = get_interative_selection_range(0, wnd.GetSafeHwnd(), "[Graph1]1!1", "Select partial plot", dwFlyoutOptions, nRangeType);
    out_str(strRange);
}