Diff of /docs/trunk/oodialog/en-US/shellObjects.xml [r9461] .. [r9462]  Maximize  Restore

  Switch to unified view

a/docs/trunk/oodialog/en-US/shellObjects.xml b/docs/trunk/oodialog/en-US/shellObjects.xml
...
...
3359
  </para>
3359
  </para>
3360
  </listitem></varlistentry>
3360
  </listitem></varlistentry>
3361
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3361
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3362
  <listitem>
3362
  <listitem>
3363
  <para>
3363
  <para>
3364
    This example ...
3364
    This example adds a static text control to the dialog right below a separator:
3365
<programlisting>
3365
<programlisting>
3366
<![CDATA[
3366
<![CDATA[
3367
  .CommonItemDialog~inherit(.CommonDialogCustomizations)
3367
  .CommonItemDialog~inherit(.CommonDialogCustomizations)
3368
3368
3369
  sfd = .SaveFileDialog~new
3369
  sfd = .SaveFileDialog~new
...
...
3628
<section id="mthGetControlItemState" xreflabel="getControlItemState"><title>getControlItemState</title>
3628
<section id="mthGetControlItemState" xreflabel="getControlItemState"><title>getControlItemState</title>
3629
<indexterm><primary>getControlItemState</primary></indexterm>
3629
<indexterm><primary>getControlItemState</primary></indexterm>
3630
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getControlItemState</secondary></indexterm>
3630
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getControlItemState</secondary></indexterm>
3631
<programlisting>
3631
<programlisting>
3632
<![CDATA[
3632
<![CDATA[
3633
>>--getControlItemState(--+--------+--)---------------------------------------------><
3633
>>--getControlItemState(--containerID--,--itemID--)-------------><
3634
                  +--type--+
3635
]]>
3634
]]>
3636
</programlisting>
3635
</programlisting>
3637
3636
3638
<para>
3637
<para>
3639
  xx
3638
  Gets the current state of an item in a container control found in the dialog.
3640
</para>
3639
</para>
3641
<variablelist>
3640
<variablelist>
3642
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3641
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3643
  <listitem>
3642
  <listitem>
3644
  <para>
3643
  <para>
3645
    The arguments are:
3644
    The arguments are:
3646
  </para>
3645
  </para>
3647
  <variablelist>
3646
  <variablelist>
3648
    <varlistentry><term>TERM</term>
3647
    <varlistentry><term>containerID [required]</term>
3649
    <listitem>
3648
    <listitem>
3649
    <para>
3650
      The resource ID of the container the control item is in. May be numeric or <xref linkend="defSymbolicId"/>.
3650
    <para>
3651
    </para>
3651
      xx
3652
    </listitem></varlistentry>
3653
    <varlistentry><term>itemID [required]</term>
3654
    <listitem>
3655
    <para>
3656
      The resource ID of the control item. May be numeric or <xref linkend="defSymbolicId"/>.
3652
    </para>
3657
    </para>
3653
    </listitem></varlistentry>
3658
    </listitem></varlistentry>
3654
  </variablelist>
3659
  </variablelist>
3655
  </listitem></varlistentry>
3660
  </listitem></varlistentry>
3656
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3661
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3657
  <listitem>
3662
  <listitem>
3658
  <para>
3663
  <para>
3659
    xx
3664
    Returns exactly one of the following keyword strings, or the <computeroutput>.nil</computeroutput> object on error. If
3665
    an error were to happen, the <computeroutput>.SystemErrorCode</computeroutput> will be set:
3666
    <variablelist>
3667
      <varlistentry><term>Inactive:</term>
3668
      <listitem>
3669
      <para>
3670
        The control is not accessible by the user. It is hidden and disabled.
3660
  </para>
3671
      </para>
3661
  </listitem></varlistentry>
3672
      </listitem></varlistentry>
3662
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3673
      <varlistentry><term>Enabled:</term>
3663
  <listitem>
3674
      <listitem>
3675
      <para>
3676
        The control is enabled, but not visible.
3677
      </para>
3678
      </listitem></varlistentry>
3679
      <varlistentry><term>Visible:</term>
3680
      <listitem>
3681
      <para>
3682
        The control is visible, but disabled.
3683
      </para>
3684
      </listitem></varlistentry>
3685
      <varlistentry><term>EnabledVisible</term>
3686
      <listitem>
3687
      <para>
3688
        The control is visible and enabled.
3689
      </para>
3690
      </listitem></varlistentry>
3691
    </variablelist>
3664
  <para>
3692
  </para>
3665
    Additional comments.
3693
  </listitem></varlistentry>
3694
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3695
  <listitem>
3696
  <para>
3697
    The default state of a control item is enabled and visible. Items in control groups cannot be changed after they have
3698
    been created, with the exception of their enabled and visible states. Container controls include radio button groups,
3699
    combo boxes, drop-down lists on the Open or Save button, and menus.
3666
  </para>
3700
  </para>
3667
  </listitem></varlistentry>
3701
  </listitem></varlistentry>
3668
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3702
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3669
  <listitem>
3703
  <listitem>
3670
  <para>
3704
  <para>
...
...
3675
  </para>
3709
  </para>
3676
  </listitem></varlistentry>
3710
  </listitem></varlistentry>
3677
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3711
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3678
  <listitem>
3712
  <listitem>
3679
  <para>
3713
  <para>
3680
    This example ...
3714
    This example shows a <xref linkend="mthOnFileOk"/> event handler that first checks if the
3715
    <computeroutput>.rex</computeroutput> radio button has not been hidden or disabled. If so, it then checks if that radio
3716
    button is the selected radio button in a radio button list:
3681
<programlisting>
3717
<programlisting>
3682
<![CDATA[
3718
<![CDATA[
3719
::class 'CDEvents' subclass CommonDialogEvents
3683
3720
3721
::method onFileOk unguarded
3722
  use arg cfd, hwnd
3723
3724
  state = cfd~getControlItemState(IDC_RBL_RADIOS, IDC_RB_REX)
3725
  if state == 'EnabledVisible' & state \== .nil then do
3726
    -- See if .rex is selected
3727
    if cfd~getSelectedControlItem(IDC_RBL_RADIOS) == .constDir[IDC_RB_REX] then do
3728
      -- Do something ...
3729
    end
3730
    else do
3731
      -- Do some other thing
3732
    end
3733
  end
3734
3735
  return self~S_OK
3684
]]>
3736
]]>
3685
</programlisting>
3737
</programlisting>
3686
  </para>
3738
  </para>
3687
  </listitem></varlistentry>
3739
  </listitem></varlistentry>
3688
</variablelist>
3740
</variablelist>
...
...
3691
<section id="mthGetControlState" xreflabel="getControlState"><title>getControlState</title>
3743
<section id="mthGetControlState" xreflabel="getControlState"><title>getControlState</title>
3692
<indexterm><primary>getControlState</primary></indexterm>
3744
<indexterm><primary>getControlState</primary></indexterm>
3693
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getControlState</secondary></indexterm>
3745
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getControlState</secondary></indexterm>
3694
<programlisting>
3746
<programlisting>
3695
<![CDATA[
3747
<![CDATA[
3696
>>--getControlState(--+--------+--)---------------------------------------------><
3748
>>--getControlState(--id--)----------------------><
3697
                  +--type--+
3698
]]>
3749
]]>
3699
</programlisting>
3750
</programlisting>
3700
3751
3701
<para>
3702
  xx
3703
</para>
3752
<para>
3704
<variablelist>
3753
  Gets the current visibility and enabled states of the specified control.
3705
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3706
  <listitem>
3707
  <para>
3754
</para>
3708
    The arguments are:
3755
<variablelist>
3756
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3757
  <listitem>
3758
  <para>
3759
    The single argument is:
3709
  </para>
3760
  </para>
3710
  <variablelist>
3761
  <variablelist>
3711
    <varlistentry><term>TERM</term>
3762
    <varlistentry><term>id [required]</term>
3712
    <listitem>
3763
    <listitem>
3713
    <para>
3764
    <para>
3714
      xx
3765
      The resource ID of the control whose state is being sought. May be numeric or <xref linkend="defSymbolicId"/>.
3715
    </para>
3766
    </para>
3716
    </listitem></varlistentry>
3767
    </listitem></varlistentry>
3717
  </variablelist>
3768
  </variablelist>
3718
  </listitem></varlistentry>
3769
  </listitem></varlistentry>
3719
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3770
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3720
  <listitem>
3771
  <listitem>
3721
  <para>
3772
  <para>
3722
    xx
3773
    Returns exactly one of the following keyword strings, or the <computeroutput>.nil</computeroutput> object on error. If
3774
    an error were to happen, the <computeroutput>.SystemErrorCode</computeroutput> will be set:
3775
    <variablelist>
3776
      <varlistentry><term>Inactive:</term>
3777
      <listitem>
3778
      <para>
3779
        The control is not accessible by the user. It is hidden and disabled.
3723
  </para>
3780
      </para>
3724
  </listitem></varlistentry>
3781
      </listitem></varlistentry>
3725
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3782
      <varlistentry><term>Enabled:</term>
3726
  <listitem>
3783
      <listitem>
3784
      <para>
3785
        The control is enabled, but not visible.
3786
      </para>
3787
      </listitem></varlistentry>
3788
      <varlistentry><term>Visible:</term>
3789
      <listitem>
3790
      <para>
3791
        The control is visible, but disabled.
3792
      </para>
3793
      </listitem></varlistentry>
3794
      <varlistentry><term>EnabledVisible</term>
3795
      <listitem>
3796
      <para>
3797
        The control is visible and enabled.
3798
      </para>
3799
      </listitem></varlistentry>
3800
    </variablelist>
3727
  <para>
3801
  </para>
3728
    Additional comments.
3802
  </listitem></varlistentry>
3803
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3804
  <listitem>
3805
  <para>
3806
    This method is very similar to the <xref linkend="mthGetControlItemState"/> method, but it is used for controls that are
3807
    <emphasis role="italic">not</emphasis> in a container.
3729
  </para>
3808
  </para>
3730
  </listitem></varlistentry>
3809
  </listitem></varlistentry>
3731
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3810
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3732
  <listitem>
3811
  <listitem>
3733
  <para>
3812
  <para>
3734
    Raises syntax errors when incorrect usage is detected.
3813
    Raises syntax errors when incorrect usage is detected.
3735
  </para>
3814
  </para>
3736
  <para>
3815
  <para>
3737
    Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
3816
    Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
3738
  </para>
3739
  </listitem></varlistentry>
3740
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3741
  <listitem>
3742
  <para>
3743
    This example ...
3744
<programlisting>
3745
<![CDATA[
3746
3747
]]>
3748
</programlisting>
3749
  </para>
3817
  </para>
3750
  </listitem></varlistentry>
3818
  </listitem></varlistentry>
3751
</variablelist>
3819
</variablelist>
3752
</section>  <!-- End CommonDialogCustomizations::getControlState() -->
3820
</section>  <!-- End CommonDialogCustomizations::getControlState() -->
3753
3821
3754
<section id="mthGetEditBoxText" xreflabel="getEditBoxText"><title>getEditBoxText</title>
3822
<section id="mthGetEditBoxText" xreflabel="getEditBoxText"><title>getEditBoxText</title>
3755
<indexterm><primary>getEditBoxText</primary></indexterm>
3823
<indexterm><primary>getEditBoxText</primary></indexterm>
3756
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getEditBoxText</secondary></indexterm>
3824
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getEditBoxText</secondary></indexterm>
3757
<programlisting>
3825
<programlisting>
3758
<![CDATA[
3826
<![CDATA[
3759
>>--getEditBoxText(--+--------+--)---------------------------------------------><
3827
>>--getEditBoxText(--id--)-----------------------><
3760
                  +--type--+
3761
]]>
3828
]]>
3762
</programlisting>
3829
</programlisting>
3763
3830
3764
<para>
3765
  xx
3766
</para>
3831
<para>
3767
<variablelist>
3832
  Gets the current text in an edit box control.
3768
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3769
  <listitem>
3770
  <para>
3833
</para>
3771
    The arguments are:
3834
<variablelist>
3835
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3836
  <listitem>
3837
  <para>
3838
    The single argument is:
3772
  </para>
3839
  </para>
3773
  <variablelist>
3840
  <variablelist>
3774
    <varlistentry><term>TERM</term>
3841
    <varlistentry><term>id [required]</term>
3775
    <listitem>
3842
    <listitem>
3776
    <para>
3843
    <para>
3777
      xx
3844
      The resource ID of the edit box. May be numeric or <xref linkend="defSymbolicId"/>.
3778
    </para>
3845
    </para>
3779
    </listitem></varlistentry>
3846
    </listitem></varlistentry>
3780
  </variablelist>
3847
  </variablelist>
3781
  </listitem></varlistentry>
3848
  </listitem></varlistentry>
3782
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3849
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3783
  <listitem>
3850
  <listitem>
3784
  <para>
3851
  <para>
3785
    xx
3852
    Returns the text in the specified edit box, the <computeroutput>.nil</computeroutput> object on error. On error the
3786
  </para>
3853
  <computeroutput>.SystemErrorCode</computeroutput> will be set.
3787
  </listitem></varlistentry>
3788
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3789
  <listitem>
3790
  <para>
3791
    Additional comments.
3792
  </para>
3854
  </para>
3793
  </listitem></varlistentry>
3855
  </listitem></varlistentry>
3794
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3856
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3795
  <listitem>
3857
  <listitem>
3796
  <para>
3858
  <para>
...
...
3801
  </para>
3863
  </para>
3802
  </listitem></varlistentry>
3864
  </listitem></varlistentry>
3803
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3865
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3804
  <listitem>
3866
  <listitem>
3805
  <para>
3867
  <para>
3806
    This example ...
3868
    This example if from an application that saves a comment with each file when it is saved. When the save file dialog is
3869
    ended, the application checks that the comment is not blank:
3807
<programlisting>
3870
<programlisting>
3808
<![CDATA[
3871
<![CDATA[
3872
::class 'CDEvents' subclass CommonDialogEvents
3809
3873
3874
::method onFileOk unguarded
3875
  use arg cfd, hwnd
3876
3877
  text = cfd~getEditBoxText(IDC_EDIT); say 'text:' text
3878
  if text == '' then do
3879
    title = 'Save File Error'
3880
    msg = 'You must enter a comment when saving this'.endOfLine || -
3881
          'file. The comment will be saved along with the file.'
3882
3883
    j = MessageDialog(msg, hwnd, title, OK, ERROR)
3884
    return self~S_FALSE
3885
  end
3886
3887
  return self~S_OK
3810
]]>
3888
]]>
3811
</programlisting>
3889
</programlisting>
3812
  </para>
3890
  </para>
3813
  </listitem></varlistentry>
3891
  </listitem></varlistentry>
3814
</variablelist>
3892
</variablelist>
...
...
3817
<section id="mthGetSelectedControlItem" xreflabel="getSelectedControlItem"><title>getSelectedControlItem</title>
3895
<section id="mthGetSelectedControlItem" xreflabel="getSelectedControlItem"><title>getSelectedControlItem</title>
3818
<indexterm><primary>getSelectedControlItem</primary></indexterm>
3896
<indexterm><primary>getSelectedControlItem</primary></indexterm>
3819
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getSelectedControlItem</secondary></indexterm>
3897
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>getSelectedControlItem</secondary></indexterm>
3820
<programlisting>
3898
<programlisting>
3821
<![CDATA[
3899
<![CDATA[
3822
>>--getSelectedControlItem(--+--------+--)---------------------------------------------><
3900
>>--getSelectedControlItem(--idContainer--)---------------------------------------------><
3823
                  +--type--+
3824
]]>
3901
]]>
3825
</programlisting>
3902
</programlisting>
3826
3903
3827
<para>
3904
<para>
3828
  xx
3905
  xx
...
...
3832
  <listitem>
3909
  <listitem>
3833
  <para>
3910
  <para>
3834
    The arguments are:
3911
    The arguments are:
3835
  </para>
3912
  </para>
3836
  <variablelist>
3913
  <variablelist>
3837
    <varlistentry><term>TERM</term>
3914
    <varlistentry><term>idContainer [required]</term>
3838
    <listitem>
3915
    <listitem>
3839
    <para>
3916
    <para>
3840
      xx
3917
      The resource ID of the container control. May be numeric or <xref linkend="defSymbolicId"/>.
3841
    </para>
3918
    </para>
3842
    </listitem></varlistentry>
3919
    </listitem></varlistentry>
3843
  </variablelist>
3920
  </variablelist>
3844
  </listitem></varlistentry>
3921
  </listitem></varlistentry>
3845
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3922
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3846
  <listitem>
3923
  <listitem>
3847
  <para>
3924
  <para>
3848
    xx
3925
    Returns the ID of the control item in the container that is the current selected item, or the
3849
  </para>
3926
    <computeroutput>.nil</computeroutput> object on error.
3850
  </listitem></varlistentry>
3851
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3852
  <listitem>
3853
  <para>
3927
  </para>
3854
    Additional comments.
3928
  </listitem></varlistentry>
3929
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3930
  <listitem>
3931
  <para>
3932
    To determine the user's final choice, this method can be called on radio button groups, combo boxes, and drop-down
3933
    lists on the Open or Save button <emphasis role="italic">after</emphasis> the dialog has closed. This method cannot be
3934
    called on menus. For radio button groups and combo boxes, this method <emphasis role="italic">can also</emphasis> be
3935
    called while the dialog is showing, to determine the current choice.
3855
  </para>
3936
  </para>
3856
  </listitem></varlistentry>
3937
  </listitem></varlistentry>
3857
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3938
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3858
  <listitem>
3939
  <listitem>
3859
  <para>
3940
  <para>
...
...
3864
  </para>
3945
  </para>
3865
  </listitem></varlistentry>
3946
  </listitem></varlistentry>
3866
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3947
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3867
  <listitem>
3948
  <listitem>
3868
  <para>
3949
  <para>
3869
    This example ...
3950
    This example gets the selected radio button in a radio button list to test if the selection is the .rex radio button:
3870
<programlisting>
3951
<programlisting>
3871
<![CDATA[
3952
<![CDATA[
3953
::class 'CDEvents' subclass CommonDialogEvents
3872
3954
3955
::method onFileOk unguarded
3956
  use arg cfd, hwnd
3957
3958
  state = cfd~getControlItemState(IDC_RBL_RADIOS, IDC_RB_REX)
3959
  if state == 'EnabledVisible' & state \== .nil then do
3960
    -- See if .rex is selected
3961
    if cfd~getSelectedControlItem(IDC_RBL_RADIOS) == .constDir[IDC_RB_REX] then do
3962
      -- Do something ...
3963
    end
3964
    else do
3965
      -- Do some other thing
3966
    end
3967
  end
3968
3969
  return self~S_OK
3873
]]>
3970
]]>
3874
</programlisting>
3971
</programlisting>
3875
  </para>
3972
  </para>
3876
  </listitem></varlistentry>
3973
  </listitem></varlistentry>
3877
</variablelist>
3974
</variablelist>
...
...
3880
<section id="mthIsCheckedCdc" xreflabel="isChecked"><title>isChecked</title>
3977
<section id="mthIsCheckedCdc" xreflabel="isChecked"><title>isChecked</title>
3881
<indexterm><primary>isChecked</primary><secondary>CommonDialogCustomizations class</secondary></indexterm>
3978
<indexterm><primary>isChecked</primary><secondary>CommonDialogCustomizations class</secondary></indexterm>
3882
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>isChecked</secondary></indexterm>
3979
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>isChecked</secondary></indexterm>
3883
<programlisting>
3980
<programlisting>
3884
<![CDATA[
3981
<![CDATA[
3885
>>--isChecked(--+--------+--)---------------------------------------------><
3982
>>--isChecked(--id--)----------------------------><
3886
                  +--type--+
3887
]]>
3983
]]>
3888
</programlisting>
3984
</programlisting>
3889
3985
3890
<para>
3986
<para>
3891
  Returns true if the specified check box is checked and false if it is not checked.
3987
  Returns true if the specified check box is checked and false if it is not checked.
...
...
3898
  </para>
3994
  </para>
3899
  <variablelist>
3995
  <variablelist>
3900
    <varlistentry><term>id [required]</term>
3996
    <varlistentry><term>id [required]</term>
3901
    <listitem>
3997
    <listitem>
3902
    <para>
3998
    <para>
3903
      The resource ID of the drop-down list. May be numeric or <xref linkend="defSymbolicId"/>.
3999
      The resource ID of the check box. May be numeric or <xref linkend="defSymbolicId"/>.
3904
    </para>
4000
    </para>
3905
    </listitem></varlistentry>
4001
    </listitem></varlistentry>
3906
  </variablelist>
4002
  </variablelist>
3907
  </listitem></varlistentry>
4003
  </listitem></varlistentry>
3908
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4004
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
...
...
3933
<section id="mthMakeProminent" xreflabel="makeProminent"><title>makeProminent</title>
4029
<section id="mthMakeProminent" xreflabel="makeProminent"><title>makeProminent</title>
3934
<indexterm><primary>makeProminent</primary></indexterm>
4030
<indexterm><primary>makeProminent</primary></indexterm>
3935
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>makeProminent</secondary></indexterm>
4031
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>makeProminent</secondary></indexterm>
3936
<programlisting>
4032
<programlisting>
3937
<![CDATA[
4033
<![CDATA[
3938
>>--makeProminent(--+--------+--)---------------------------------------------><
4034
>>--makeProminent(--id--)------------------------><
3939
                  +--type--+
3940
]]>
4035
]]>
3941
</programlisting>
4036
</programlisting>
3942
4037
3943
<para>
3944
  xx
3945
</para>
4038
<para>
3946
<variablelist>
4039
  Places a control in the dialog so that it stands out compared to other added controls.
3947
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
3948
  <listitem>
3949
  <para>
4040
</para>
3950
    The arguments are:
4041
<variablelist>
4042
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4043
  <listitem>
4044
  <para>
4045
    The single argument is:
3951
  </para>
4046
  </para>
3952
  <variablelist>
4047
  <variablelist>
3953
    <varlistentry><term>TERM</term>
4048
    <varlistentry><term>id [required]</term>
3954
    <listitem>
4049
    <listitem>
3955
    <para>
4050
    <para>
3956
      xx
4051
      The resource ID of the control to be made prominent. May be numeric or <xref linkend="defSymbolicId"/>.
3957
    </para>
4052
    </para>
3958
    </listitem></varlistentry>
4053
    </listitem></varlistentry>
3959
  </variablelist>
4054
  </variablelist>
3960
  </listitem></varlistentry>
4055
  </listitem></varlistentry>
3961
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4056
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
3962
  <listitem>
4057
  <listitem>
3963
  <para>
4058
  <para>
3964
    xx
4059
    Returns a <xref linkend="varHResult"/>. S_OK if successful, or an error value otherwise.
3965
  </para>
3966
  </listitem></varlistentry>
3967
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
3968
  <listitem>
3969
  <para>
4060
  </para>
3970
    Additional comments.
4061
  </listitem></varlistentry>
4062
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4063
  <listitem>
4064
  <para>
4065
    This method causes the control to be placed near the Open or Save button instead of being grouped with the rest of the
4066
    custom controls. Only check boxes, push buttons, combo boxes, and menus, or a visual group that contains only a single
4067
    item of one of those types, can be made prominent.
4068
  </para>
4069
  <para>
4070
    Only one control can be marked in this way. If a dialog has only one added control, that control is marked as prominent
4071
    by default.
3971
  </para>
4072
  </para>
3972
  </listitem></varlistentry>
4073
  </listitem></varlistentry>
3973
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4074
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
3974
  <listitem>
4075
  <listitem>
3975
  <para>
4076
  <para>
...
...
3980
  </para>
4081
  </para>
3981
  </listitem></varlistentry>
4082
  </listitem></varlistentry>
3982
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4083
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
3983
  <listitem>
4084
  <listitem>
3984
  <para>
4085
  <para>
3985
    This example ...
4086
    This example adds a push button and then a bunch of other controls. As a last step it uses the <emphasis
4087
    role="italic">makeProminent</emphasis> method on the push button. This places the push button next to the Save button
4088
    rather than at the beginning of the controls:
3986
<programlisting>
4089
<programlisting>
3987
<![CDATA[
4090
<![CDATA[
4091
  .CommonItemDialog~inherit(.CommonDialogCustomizations)
4092
4093
  sfd = .SaveFileDialog~new
4094
4095
  -- Customize the dialog
4096
  sfd~addPushButton(IDC_PB_DONE, 'Done Now')
4097
  ret = sfd~startVisualGroup(IDC_GB_RADIOS, 'Save file with extension:'); say 'startVisualGroup:' .DlgUtil~errMsg(ret)
4098
  ret = sfd~addRadioButtonList(IDC_RBL_RADIOS); say 'addRadioButtonList:' .DlgUtil~errMsg(ret)
4099
  ret = sfd~addControlItem(IDC_RBL_RADIOS, '*.rex', IDC_RB_REX); say 'addControlItem:' .DlgUtil~errMsg(ret)
4100
  ret = sfd~addControlItem(IDC_RBL_RADIOS, '*.txt', IDC_RB_TXT); say 'addControlItem:' .DlgUtil~errMsg(ret)
4101
  ret = sfd~addControlItem(IDC_RBL_RADIOS, '*.rxg', IDC_RB_RXG); say 'addControlItem:' .DlgUtil~errMsg(ret)
4102
  ret = sfd~endVisualGroup(); say 'endVisualGroup:' .DlgUtil~errMsg(ret)
4103
  ...
4104
  -- Set the intial state
4105
  ret = sfd~setFileTypeIndex(1)
4106
  ret = sfd~setSelectedControlItem(IDC_RBL_RADIOS, IDC_RB_REX)
4107
4108
  sfd~makeProminent(IDC_PB_DONE)
3988
4109
3989
]]>
4110
]]>
3990
</programlisting>
4111
</programlisting>
3991
  </para>
4112
  </para>
3992
  </listitem></varlistentry>
4113
  </listitem></varlistentry>
...
...
3996
<section id="mthRemoveAllControlItems" xreflabel="removeAllControlItems"><title>removeAllControlItems</title>
4117
<section id="mthRemoveAllControlItems" xreflabel="removeAllControlItems"><title>removeAllControlItems</title>
3997
<indexterm><primary>removeAllControlItems</primary></indexterm>
4118
<indexterm><primary>removeAllControlItems</primary></indexterm>
3998
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>removeAllControlItems</secondary></indexterm>
4119
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>removeAllControlItems</secondary></indexterm>
3999
<programlisting>
4120
<programlisting>
4000
<![CDATA[
4121
<![CDATA[
4001
>>--removeAllControlItems(--+--------+--)---------------------------------------------><
4122
>>--removeAllControlItems(--idContainer--)-------><
4002
                  +--type--+
4003
]]>
4123
]]>
4004
</programlisting>
4124
</programlisting>
4005
4125
4006
<para>
4126
<para>
4007
  xx
4127
  Removes all items from a container control in the dialog.
4008
</para>
4128
</para>
4009
<variablelist>
4129
<variablelist>
4010
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4130
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4011
  <listitem>
4131
  <listitem>
4012
  <para>
4132
  <para>
4013
    The arguments are:
4133
    The arguments are:
4014
  </para>
4134
  </para>
4015
  <variablelist>
4135
  <variablelist>
4016
    <varlistentry><term>TERM</term>
4136
    <varlistentry><term>idContainer [required]</term>
4017
    <listitem>
4137
    <listitem>
4018
    <para>
4138
    <para>
4019
      xx
4139
      The resource ID of the container control. May be numeric or <xref linkend="defSymbolicId"/>.
4020
    </para>
4140
    </para>
4021
    </listitem></varlistentry>
4141
    </listitem></varlistentry>
4022
  </variablelist>
4142
  </variablelist>
4023
  </listitem></varlistentry>
4143
  </listitem></varlistentry>
4024
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4144
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4025
  <listitem>
4145
  <listitem>
4026
  <para>
4146
  <para>
4027
    xx
4147
    Returns a <xref linkend="varHResult"/>. S_OK if successful, or an error value otherwise.
4028
  </para>
4029
  </listitem></varlistentry>
4030
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4031
  <listitem>
4032
  <para>
4148
  </para>
4033
    Additional comments.
4149
  </listitem></varlistentry>
4150
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4151
  <listitem>
4152
  <para>
4153
    Container controls include radio button groups, combo boxes, drop-down lists on the Open or Save button, and menus.
4154
    Testing has shown that the operating system returns <link linkend="clsComConstants">E_NOTIMPL</link> when this method is
4155
    invoked on the COM object. It may be that the COM object implements the method in later versions of Windows.
4034
  </para>
4156
  </para>
4035
  </listitem></varlistentry>
4157
  </listitem></varlistentry>
4036
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4158
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4037
  <listitem>
4159
  <listitem>
4038
  <para>
4160
  <para>
4039
    Raises syntax errors when incorrect usage is detected.
4161
    Raises syntax errors when incorrect usage is detected.
4040
  </para>
4162
  </para>
4041
  <para>
4163
  <para>
4042
    Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
4164
    Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
4043
  </para>
4044
  </listitem></varlistentry>
4045
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4046
  <listitem>
4047
  <para>
4048
    This example ...
4049
<programlisting>
4050
<![CDATA[
4051
4052
]]>
4053
</programlisting>
4054
  </para>
4165
  </para>
4055
  </listitem></varlistentry>
4166
  </listitem></varlistentry>
4056
</variablelist>
4167
</variablelist>
4057
</section>  <!-- End CommonDialogCustomizations::removeAllControlItems() -->
4168
</section>  <!-- End CommonDialogCustomizations::removeAllControlItems() -->
4058
4169
4059
<section id="mthRemoveControlItem" xreflabel="removeControlItem"><title>removeControlItem</title>
4170
<section id="mthRemoveControlItem" xreflabel="removeControlItem"><title>removeControlItem</title>
4060
<indexterm><primary>removeControlItem</primary></indexterm>
4171
<indexterm><primary>removeControlItem</primary></indexterm>
4061
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>removeControlItem</secondary></indexterm>
4172
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>removeControlItem</secondary></indexterm>
4062
<programlisting>
4173
<programlisting>
4063
<![CDATA[
4174
<![CDATA[
4064
>>--removeControlItem(--+--------+--)---------------------------------------------><
4175
>>--removeControlItem(--containerID--,--itemID--)---------------><
4065
                  +--type--+
4066
]]>
4176
]]>
4067
</programlisting>
4177
</programlisting>
4068
4178
4069
<para>
4179
<para>
4070
  xx
4180
  Removes an item from a container control in the dialog.
4071
</para>
4181
</para>
4072
<variablelist>
4182
<variablelist>
4073
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4183
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4074
  <listitem>
4184
  <listitem>
4075
  <para>
4185
  <para>
4076
    The arguments are:
4186
    The arguments are:
4077
  </para>
4187
  </para>
4078
  <variablelist>
4188
  <variablelist>
4079
    <varlistentry><term>TERM</term>
4189
    <varlistentry><term>containerID [required]</term>
4080
    <listitem>
4190
    <listitem>
4191
    <para>
4192
      The resource ID of the container to which the control item is being removed. May be numeric or <xref
4193
      linkend="defSymbolicId"/>.
4081
    <para>
4194
    </para>
4082
      xx
4195
    </listitem></varlistentry>
4196
    <varlistentry><term>itemID [required]</term>
4197
    <listitem>
4198
    <para>
4199
      The resource ID of the control item. May be numeric or <xref linkend="defSymbolicId"/>.
4083
    </para>
4200
    </para>
4084
    </listitem></varlistentry>
4201
    </listitem></varlistentry>
4085
  </variablelist>
4202
  </variablelist>
4086
  </listitem></varlistentry>
4203
  </listitem></varlistentry>
4087
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4204
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4088
  <listitem>
4205
  <listitem>
4089
  <para>
4206
  <para>
4090
    xx
4207
    Returns a <xref linkend="varHResult"/>. S_OK if successful, or an error value otherwise.
4091
  </para>
4092
  </listitem></varlistentry>
4093
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4094
  <listitem>
4095
  <para>
4208
  </para>
4096
    Additional comments.
4209
  </listitem></varlistentry>
4210
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4211
  <listitem>
4212
  <para>
4213
    Container controls include radio button groups, combo boxes, drop-down lists on the Open or Save button, and menus.
4214
    Testing has shown that the operating system returns <link linkend="clsComConstants">E_NOTIMPL</link> when this method is
4215
    invoked on radio button list COM container object. But, it seems to work fine on other containers. It may be that the
4216
    radio button list COM object implements the method in later versions of Windows.
4097
  </para>
4217
  </para>
4098
  </listitem></varlistentry>
4218
  </listitem></varlistentry>
4099
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4219
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4100
  <listitem>
4220
  <listitem>
4101
  <para>
4221
  <para>
...
...
4106
  </para>
4226
  </para>
4107
  </listitem></varlistentry>
4227
  </listitem></varlistentry>
4108
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4228
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4109
  <listitem>
4229
  <listitem>
4110
  <para>
4230
  <para>
4111
    This example ...
4231
    This example removes all the menu items from a menu by removing them one by one:
4112
<programlisting>
4232
<programlisting>
4113
<![CDATA[
4233
<![CDATA[
4114
4234
4235
  ret = cfd~removeControlItem(IDC_MENU, IDC_MENU_REX)
4236
  ret = cfd~removeControlItem(IDC_MENU, IDC_MENU_TXT)
4237
  ret = cfd~removeControlItem(IDC_MENU, IDC_MENU_CONSOLE)
4115
]]>
4238
]]>
4116
</programlisting>
4239
</programlisting>
4117
  </para>
4240
  </para>
4118
  </listitem></varlistentry>
4241
  </listitem></varlistentry>
4119
</variablelist>
4242
</variablelist>
...
...
4122
<section id="mthSetCheckButtonState" xreflabel="setCheckButtonState"><title>setCheckButtonState</title>
4245
<section id="mthSetCheckButtonState" xreflabel="setCheckButtonState"><title>setCheckButtonState</title>
4123
<indexterm><primary>setCheckButtonState</primary></indexterm>
4246
<indexterm><primary>setCheckButtonState</primary></indexterm>
4124
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>setCheckButtonState</secondary></indexterm>
4247
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>setCheckButtonState</secondary></indexterm>
4125
<programlisting>
4248
<programlisting>
4126
<![CDATA[
4249
<![CDATA[
4127
>>--setCheckButtonState(--+--------+--)---------------------------------------------><
4250
>>--setCheckButtonState(--id--,--checked--)------><
4128
                  +--type--+
4129
]]>
4251
]]>
4130
</programlisting>
4252
</programlisting>
4131
4253
4132
<para>
4254
<para>
4133
  xx
4255
  Sets the state of a check box, checked or not checked, in the dialog.
4134
</para>
4256
</para>
4135
<variablelist>
4257
<variablelist>
4136
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4258
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4137
  <listitem>
4259
  <listitem>
4138
  <para>
4260
  <para>
4139
    The arguments are:
4261
    The arguments are:
4140
  </para>
4262
  </para>
4141
  <variablelist>
4263
  <variablelist>
4142
    <varlistentry><term>TERM</term>
4264
    <varlistentry><term>id [required]</term>
4143
    <listitem>
4265
    <listitem>
4266
    <para>
4267
      The resource ID of the check box. May be numeric or <xref linkend="defSymbolicId"/>.
4144
    <para>
4268
    </para>
4145
      xx
4269
    </listitem></varlistentry>
4270
    <varlistentry><term>checked [required]</term>
4271
    <listitem>
4272
    <para>
4273
      True or false. True to set the check box state to checked and false to set it to unchecked.
4146
    </para>
4274
    </para>
4147
    </listitem></varlistentry>
4275
    </listitem></varlistentry>
4148
  </variablelist>
4276
  </variablelist>
4149
  </listitem></varlistentry>
4277
  </listitem></varlistentry>
4150
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4278
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4151
  <listitem>
4279
  <listitem>
4152
  <para>
4280
  <para>
4153
    xx
4281
    Returns a <xref linkend="varHResult"/>. S_OK if successful, or an error value otherwise.
4154
  </para>
4155
  </listitem></varlistentry>
4156
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4157
  <listitem>
4158
  <para>
4282
  </para>
4159
    Additional comments.
4283
  </listitem></varlistentry>
4284
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4285
  <listitem>
4286
  <para>
4287
    The <xref linkend="mthCheckCdc"/> and <xref linkend="mthUncheckCdc"/> methods are convenience methods that produce
4288
    similar results and eliminate the need to supply a second argument.
4160
  </para>
4289
  </para>
4161
  </listitem></varlistentry>
4290
  </listitem></varlistentry>
4162
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4291
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4163
  <listitem>
4292
  <listitem>
4164
  <para>
4293
  <para>
4165
    Raises syntax errors when incorrect usage is detected.
4294
    Raises syntax errors when incorrect usage is detected.
4166
  </para>
4295
  </para>
4167
  <para>
4296
  <para>
4168
    Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
4297
    Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
4169
  </para>
4170
  </listitem></varlistentry>
4171
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4172
  <listitem>
4173
  <para>
4174
    This example ...
4175
<programlisting>
4176
<![CDATA[
4177
4178
]]>
4179
</programlisting>
4180
  </para>
4298
  </para>
4181
  </listitem></varlistentry>
4299
  </listitem></varlistentry>
4182
</variablelist>
4300
</variablelist>
4183
</section>  <!-- End CommonDialogCustomizations::setCheckButtonState() -->
4301
</section>  <!-- End CommonDialogCustomizations::setCheckButtonState() -->
4184
4302
4185
<section id="mthSetControlItemState" xreflabel="setControlItemState"><title>setControlItemState</title>
4303
<section id="mthSetControlItemState" xreflabel="setControlItemState"><title>setControlItemState</title>
4186
<indexterm><primary>setControlItemState</primary></indexterm>
4304
<indexterm><primary>setControlItemState</primary></indexterm>
4187
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>setControlItemState</secondary></indexterm>
4305
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>setControlItemState</secondary></indexterm>
4188
<programlisting>
4306
<programlisting>
4189
<![CDATA[
4307
<![CDATA[
4190
>>--setControlItemState(--+--------+--)---------------------------------------------><
4308
>>--setControlItemState(--containerID--,--itemID--,--state--)---><
4191
                  +--type--+
4192
]]>
4309
]]>
4193
</programlisting>
4310
</programlisting>
4194
4311
4195
<para>
4312
<para>
4196
  xx
4313
  xx
...
...
4200
  <listitem>
4317
  <listitem>
4201
  <para>
4318
  <para>
4202
    The arguments are:
4319
    The arguments are:
4203
  </para>
4320
  </para>
4204
  <variablelist>
4321
  <variablelist>
4205
    <varlistentry><term>TERM</term>
4322
    <varlistentry><term>containerID [required]</term>
4206
    <listitem>
4323
    <listitem>
4324
    <para>
4325
      The resource ID of the container in which the state of the control item is being set. May be numeric or <xref
4326
      linkend="defSymbolicId"/>.
4207
    <para>
4327
    </para>
4208
      xx
4328
    </listitem></varlistentry>
4329
    <varlistentry><term>itemID [required]</term>
4330
    <listitem>
4331
    <para>
4332
      The resource ID of the control item. May be numeric or <xref linkend="defSymbolicId"/>.
4333
    </para>
4334
    </listitem></varlistentry>
4335
    <varlistentry><term>state [required]</term>
4336
    <listitem>
4337
    <para>
4338
      Exactly one of the following keywords that specified the state to set, case is not significant:
4339
    </para>
4340
    <para>
4341
      <simplelist type='vert' columns='3'>
4342
        <member>INACTIVE  </member>
4343
        <member>ENABLED   </member>
4344
        <member>VISIBLE   </member>
4345
        <member>ENABLEDVISIBLE</member>
4346
      </simplelist>
4347
      <variablelist>
4348
        <varlistentry><term>INACTIVE</term>
4349
        <listitem>
4350
        <para>
4351
          The control item is disabled and hidden.
4352
        </para>
4353
        </listitem></varlistentry>
4354
        <varlistentry><term>ENABLED</term>
4355
        <listitem>
4356
        <para>
4357
          The control item is enabled, but it is not visible to the user.
4358
        </para>
4359
        </listitem></varlistentry>
4360
        <varlistentry><term>VISIBLE</term>
4361
        <listitem>
4362
        <para>
4363
          The control item is disabled, but visible.
4364
        </para>
4365
        </listitem></varlistentry>
4366
        <varlistentry><term>ENABLEDVISIBLE</term>
4367
        <listitem>
4368
        <para>
4369
          The control item is enabled and visible.
4370
        </para>
4371
        </listitem></varlistentry>
4372
      </variablelist>
4209
    </para>
4373
    </para>
4210
    </listitem></varlistentry>
4374
    </listitem></varlistentry>
4211
  </variablelist>
4375
  </variablelist>
4212
  </listitem></varlistentry>
4376
  </listitem></varlistentry>
4213
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4377
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4214
  <listitem>
4378
  <listitem>
4215
  <para>
4379
  <para>
4216
    xx
4380
    Returns a <xref linkend="varHResult"/>. S_OK if successful, or an error value otherwise.
4217
  </para>
4218
  </listitem></varlistentry>
4219
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4220
  <listitem>
4221
  <para>
4381
  </para>
4222
    Additional comments.
4382
  </listitem></varlistentry>
4383
  <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
4384
  <listitem>
4385
  <para>
4386
    The default state of a control item is enabled and visible. Items in control groups cannot be changed after they have
4387
    been created, with the exception of their enabled and visible states. Container controls include radio button groups,
4388
    combo boxes, drop-down lists on the Open or Save button, and menus.
4223
  </para>
4389
  </para>
4224
  </listitem></varlistentry>
4390
  </listitem></varlistentry>
4225
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4391
  <varlistentry><term><emphasis role="bold">Details</emphasis></term>
4226
  <listitem>
4392
  <listitem>
4227
  <para>
4393
  <para>
...
...
4232
  </para>
4398
  </para>
4233
  </listitem></varlistentry>
4399
  </listitem></varlistentry>
4234
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4400
  <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
4235
  <listitem>
4401
  <listitem>
4236
  <para>
4402
  <para>
4237
    This example ...
4403
    This example hides and disables one of the menu items in a menu:
4238
<programlisting>
4404
<programlisting>
4239
<![CDATA[
4405
<![CDATA[
4406
  ret = cfd~setControlItemState(IDC_MENU, IDC_MENU_REX, 'INACTIVE')
4240
4407
4241
]]>
4408
]]>
4242
</programlisting>
4409
</programlisting>
4243
  </para>
4410
  </para>
4244
  </listitem></varlistentry>
4411
  </listitem></varlistentry>
...
...
4248
<section id="mthSetControlItemText" xreflabel="setControlItemText"><title>setControlItemText</title>
4415
<section id="mthSetControlItemText" xreflabel="setControlItemText"><title>setControlItemText</title>
4249
<indexterm><primary>setControlItemText</primary></indexterm>
4416
<indexterm><primary>setControlItemText</primary></indexterm>
4250
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>setControlItemText</secondary></indexterm>
4417
<indexterm><primary>CommonDialogCustomizations class</primary><secondary>setControlItemText</secondary></indexterm>
4251
<programlisting>
4418
<programlisting>
4252
<![CDATA[
4419
<![CDATA[
4253
>>--setControlItemText(--+--------+--)---------------------------------------------><
4420
>>--setControlItemText(--containerID--,--itemID--,--text--)-----><
4254
                  +--type--+
4255
]]>
4421
]]>
4256
</programlisting>
4422
</programlisting>
4257
4423
4258
<para>
4424
<para>
4259
  xx
4425
  Sets the text, the label, of a control item. For example, the text that accompanies a radio button or an item in a menu.
4260
</para>
4426
</para>
4261
<variablelist>
4427
<variablelist>
4262
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4428
  <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
4263
  <listitem>
4429
  <listitem>
4264
  <para>
4430
  <para>
4265
    The arguments are:
4431
    The arguments are:
4266
  </para>
4432
  </para>
4267
  <variablelist>
4433
  <variablelist>
4268
    <varlistentry><term>TERM</term>
4434
    <varlistentry><term>containerID [required]</term>
4269
    <listitem>
4435
    <listitem>
4436
    <para>
4437
      The resource ID of the container in which the text of the control item is being set. May be numeric or <xref
4438
      linkend="defSymbolicId"/>.
4270
    <para>
4439
    </para>
4271
      xx
4440
    </listitem></varlistentry>
4441
    <varlistentry><term>itemID [required]</term>
4442
    <listitem>
4443
    <para>
4444
      The resource ID of the control item. May be numeric or <xref linkend="defSymbolicId"/>.
4445
    </para>
4446
    </listitem></varlistentry>
4447
    <varlistentry><term>text [required]</term>
4448
    <listitem>
4449
    <para>
4450
      The text to set the label of the control item to.
4272
    </para>
4451
    </para>
4273
    </listitem></varlistentry>
4452
    </listitem></varlistentry>
4274
  </variablelist>
4453
  </variablelist>
4275
  </listitem></varlistentry>
4454
  </listitem></varlistentry>
4276
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
4455
  <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>