Skip to content

Commit 1f89a23

Browse files
authored
Merge pull request MicrosoftDocs#1013 from msebolt/reformat-mfc-reference-pr2
reformat-mfc-reference-pr2
2 parents 834afa0 + 919207a commit 1f89a23

30 files changed

+495
-495
lines changed

docs/mfc/reference/ccomboboxex-class.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,28 @@ class CComboBoxEx : public CComboBox
3434
|Name|Description|
3535
|----------|-----------------|
3636
|[CComboBoxEx::Create](#create)|Creates the combo box and attaches it to the `CComboBoxEx` object.|
37-
|[CComboBoxEx::CreateEx](#createex)|Creates a combo box with the specified Windows extended styles and attaches it to a **ComboBoxEx** object.|
38-
|[CComboBoxEx::DeleteItem](#deleteitem)|Removes an item from a **ComboBoxEx** control.|
37+
|[CComboBoxEx::CreateEx](#createex)|Creates a combo box with the specified Windows extended styles and attaches it to a `ComboBoxEx` object.|
38+
|[CComboBoxEx::DeleteItem](#deleteitem)|Removes an item from a `ComboBoxEx` control.|
3939
|[CComboBoxEx::GetComboBoxCtrl](#getcomboboxctrl)|Retrieves a pointer to the child combo box control.|
40-
|[CComboBoxEx::GetEditCtrl](#geteditctrl)|Retrieves the handle to the edit control portion of a **ComboBoxEx** control.|
41-
|[CComboBoxEx::GetExtendedStyle](#getextendedstyle)|Retrieves the extended styles that are in use for a **ComboBoxEx** control.|
42-
|[CComboBoxEx::GetImageList](#getimagelist)|Retrieves a pointer to the image list assigned to a **ComboBoxEx** control.|
43-
|[CComboBoxEx::GetItem](#getitem)|Retrieves item information for a given **ComboBoxEx** item.|
44-
|[CComboBoxEx::HasEditChanged](#haseditchanged)|Determines if the user has changed the contents of the **ComboBoxEx** edit control by typing.|
45-
|[CComboBoxEx::InsertItem](#insertitem)|Inserts a new item in a **ComboBoxEx** control.|
46-
|[CComboBoxEx::SetExtendedStyle](#setextendedstyle)|Sets extended styles within a **ComboBoxEx** control.|
47-
|[CComboBoxEx::SetImageList](#setimagelist)|Sets an image list for a **ComboBoxEx** control.|
48-
|[CComboBoxEx::SetItem](#setitem)|Sets the attributes for an item in a **ComboBoxEx** control.|
40+
|[CComboBoxEx::GetEditCtrl](#geteditctrl)|Retrieves the handle to the edit control portion of a `ComboBoxEx` control.|
41+
|[CComboBoxEx::GetExtendedStyle](#getextendedstyle)|Retrieves the extended styles that are in use for a `ComboBoxEx` control.|
42+
|[CComboBoxEx::GetImageList](#getimagelist)|Retrieves a pointer to the image list assigned to a `ComboBoxEx` control.|
43+
|[CComboBoxEx::GetItem](#getitem)|Retrieves item information for a given `ComboBoxEx` item.|
44+
|[CComboBoxEx::HasEditChanged](#haseditchanged)|Determines if the user has changed the contents of the `ComboBoxEx` edit control by typing.|
45+
|[CComboBoxEx::InsertItem](#insertitem)|Inserts a new item in a `ComboBoxEx` control.|
46+
|[CComboBoxEx::SetExtendedStyle](#setextendedstyle)|Sets extended styles within a `ComboBoxEx` control.|
47+
|[CComboBoxEx::SetImageList](#setimagelist)|Sets an image list for a `ComboBoxEx` control.|
48+
|[CComboBoxEx::SetItem](#setitem)|Sets the attributes for an item in a `ComboBoxEx` control.|
4949
|[CComboBoxEx::SetWindowTheme](#setwindowtheme)|Sets the visual style of the extended combo box control.|
5050

5151
## Remarks
5252
By using `CComboBoxEx` to create combo box controls, you no longer need to implement your own image drawing code. Instead, use `CComboBoxEx` to access images from an image list.
5353

5454
## Image List Support
55-
In a standard combo box, the owner of the combo box is responsible for drawing an image by creating the combo box as an owner-draw control. When you use `CComboBoxEx`, you do not need to set the drawing styles **CBS_OWNERDRAWFIXED** and **CBS_HASSTRINGS** because they are implied. Otherwise, you must write code to perform drawing operations. A `CComboBoxEx` control supports up to three images per item: one for a selected state, one for an unselected state, and one for an overlay image.
55+
In a standard combo box, the owner of the combo box is responsible for drawing an image by creating the combo box as an owner-draw control. When you use `CComboBoxEx`, you do not need to set the drawing styles CBS_OWNERDRAWFIXED and CBS_HASSTRINGS because they are implied. Otherwise, you must write code to perform drawing operations. A `CComboBoxEx` control supports up to three images per item: one for a selected state, one for an unselected state, and one for an overlay image.
5656

5757
## Styles
58-
`CComboBoxEx` supports the styles **CBS_SIMPLE**, **CBS_DROPDOWN**, **CBS_DROPDOWNLIST**, and **WS_CHILD**. All other styles passed when you create the window are ignored by the control. After the window is created, you can provide other combo box styles by calling the `CComboBoxEx` member function [SetExtendedStyle](#setextendedstyle). With these styles, you can:
58+
`CComboBoxEx` supports the styles CBS_SIMPLE, CBS_DROPDOWN, CBS_DROPDOWNLIST, and WS_CHILD. All other styles passed when you create the window are ignored by the control. After the window is created, you can provide other combo box styles by calling the `CComboBoxEx` member function [SetExtendedStyle](#setextendedstyle). With these styles, you can:
5959

6060
- Set string searches in the list to be case-sensitive.
6161

@@ -112,7 +112,7 @@ virtual BOOL Create(
112112
A reference to a [CRect](../../atl-mfc-shared/reference/crect-class.md) object or [RECT](http://msdn.microsoft.com/library/windows/desktop/dd162897) structure, which is the position and size of the combo box.
113113

114114
*pParentWnd*
115-
A pointer to a [CWnd](../../mfc/reference/cwnd-class.md) object that is the parent window of the combo box (usually a `CDialog`). It must not be **NULL**.
115+
A pointer to a [CWnd](../../mfc/reference/cwnd-class.md) object that is the parent window of the combo box (usually a `CDialog`). It must not be NULL.
116116

117117
*nID*
118118
Specifies the combo box's control ID.
@@ -131,17 +131,17 @@ virtual BOOL Create(
131131

132132
When you create the combo box, you can specify any or all of the following combo-box styles:
133133

134-
- **CBS_SIMPLE**
134+
- CBS_SIMPLE
135135

136-
- **CBS_DROPDOWN**
136+
- CBS_DROPDOWN
137137

138-
- **CBS_DROPDOWNLIST**
138+
- CBS_DROPDOWNLIST
139139

140-
- **CBS_AUTOHSCROLL**
140+
- CBS_AUTOHSCROLL
141141

142-
- **WS_CHILD**
142+
- WS_CHILD
143143

144-
All other styles passed when you create the window are ignored. The **ComboBoxEx** control also supports extended styles that provide additional features. These styles are described in [ComboBoxEx control extended styles](http://msdn.microsoft.com/library/windows/desktop/bb775742), in the Windows SDK. Set these styles by calling [SetExtendedStyle](#setextendedstyle).
144+
All other styles passed when you create the window are ignored. The `ComboBoxEx` control also supports extended styles that provide additional features. These styles are described in [ComboBoxEx control extended styles](http://msdn.microsoft.com/library/windows/desktop/bb775742), in the Windows SDK. Set these styles by calling [SetExtendedStyle](#setextendedstyle).
145145

146146
If you want to use extended windows styles with your control, call [CreateEx](#createex) instead of `Create`.
147147

@@ -179,10 +179,10 @@ virtual BOOL CreateEx(
179179
### Remarks
180180
Use `CreateEx` instead of `Create` to apply extended Windows styles, specified by the Windows extended style preface **WS_EX_**.
181181

182-
`CreateEx` creates the control with the extended Windows styles specified by *dwExStyle*. You must set extended styles specific to an extended combo box control using [SetExtendedStyle](#setextendedstyle). For example, use `CreateEx` to set such styles as **WS_EX_CONTEXTHELP**, but use `SetExtendedStyle` to set such styles as **CBES_EX_CASESENSITIVE**. For more information, see the styles described in the topic [ComboBoxEx Control Extended Styles](http://msdn.microsoft.com/library/windows/desktop/bb775742) in the Windows SDK.
182+
`CreateEx` creates the control with the extended Windows styles specified by *dwExStyle*. You must set extended styles specific to an extended combo box control using [SetExtendedStyle](#setextendedstyle). For example, use `CreateEx` to set such styles as WS_EX_CONTEXTHELP, but use `SetExtendedStyle` to set such styles as CBES_EX_CASESENSITIVE. For more information, see the styles described in the topic [ComboBoxEx Control Extended Styles](http://msdn.microsoft.com/library/windows/desktop/bb775742) in the Windows SDK.
183183

184184
## <a name="deleteitem"></a> CComboBoxEx::DeleteItem
185-
Removes an item from a **ComboBoxEx** control.
185+
Removes an item from a `ComboBoxEx` control.
186186

187187
```
188188
int DeleteItem(int iIndex);
@@ -193,10 +193,10 @@ int DeleteItem(int iIndex);
193193
Zero-based index of the item to be removed.
194194

195195
### Return Value
196-
The number of items remaining in the control. If *iIndex* is invalid, the function returns **CB_ERR**.
196+
The number of items remaining in the control. If *iIndex* is invalid, the function returns CB_ERR.
197197

198198
### Remarks
199-
This member function implements the functionality of the message [CBEM_DELETEITEM](http://msdn.microsoft.com/library/windows/desktop/bb775768), as described in the Windows SDK. When you call DeleteItem, a [WM_NOTIFY](http://msdn.microsoft.com/library/windows/desktop/bb775583) message with **CBEN_DELETEITEM** notification will be sent to the parent window.
199+
This member function implements the functionality of the message [CBEM_DELETEITEM](http://msdn.microsoft.com/library/windows/desktop/bb775768), as described in the Windows SDK. When you call DeleteItem, a [WM_NOTIFY](http://msdn.microsoft.com/library/windows/desktop/bb775583) message with CBEN_DELETEITEM notification will be sent to the parent window.
200200

201201
## <a name="getcomboboxctrl"></a> CComboBoxEx::GetComboBoxCtrl
202202
Call this member function to get a pointer to a combo box control within a `CComboBoxEx` object.
@@ -224,7 +224,7 @@ CEdit* GetEditCtrl();
224224
A pointer to a [CEdit](../../mfc/reference/cedit-class.md) object.
225225

226226
### Remarks
227-
A `CComboBoxEx` control uses an edit box when it is created with the **CBS_DROPDOWN** style.
227+
A `CComboBoxEx` control uses an edit box when it is created with the CBS_DROPDOWN style.
228228

229229
The `CEdit` object pointed to by the return value is a temporary object and is destroyed during the next idle processing time.
230230

@@ -236,7 +236,7 @@ DWORD GetExtendedStyle() const;
236236
```
237237

238238
### Return Value
239-
The `DWORD` value that contains the extended styles that are used for the combo box control.
239+
The DWORD value that contains the extended styles that are used for the combo box control.
240240

241241
### Remarks
242242
See [ComboBoxEx Control Extended Styles](http://msdn.microsoft.com/library/windows/desktop/bb775742) in the Windows SDK for more information about these styles.
@@ -249,13 +249,13 @@ CImageList* GetImageList() const;
249249
```
250250

251251
### Return Value
252-
A pointer to a [CImageList](../../mfc/reference/cimagelist-class.md) object. If it fails, this member function returns **NULL**.
252+
A pointer to a [CImageList](../../mfc/reference/cimagelist-class.md) object. If it fails, this member function returns NULL.
253253

254254
### Remarks
255255
The `CImageList` object pointed to by the return value is a temporary object and is destroyed during the next idle processing time.
256256

257257
## <a name="getitem"></a> CComboBoxEx::GetItem
258-
Retrieves item information for a given **ComboBoxEx** item.
258+
Retrieves item information for a given `ComboBoxEx` item.
259259

260260
```
261261
BOOL GetItem(COMBOBOXEXITEM* pCBItem);
@@ -272,7 +272,7 @@ BOOL GetItem(COMBOBOXEXITEM* pCBItem);
272272
This member function implements the functionality of the message [CBEM_GETITEM](http://msdn.microsoft.com/library/windows/desktop/bb775779), as described in the Windows SDK.
273273

274274
## <a name="haseditchanged"></a> CComboBoxEx::HasEditChanged
275-
Determines if the user has changed the contents of the **ComboBoxEx** edit control by typing.
275+
Determines if the user has changed the contents of the `ComboBoxEx` edit control by typing.
276276

277277
```
278278
BOOL HasEditChanged();
@@ -285,7 +285,7 @@ BOOL HasEditChanged();
285285
This member function implements the functionality of the message [CBEM_HASEDITCHANGED](http://msdn.microsoft.com/library/windows/desktop/bb775782), as described in the Windows SDK.
286286

287287
## <a name="insertitem"></a> CComboBoxEx::InsertItem
288-
Inserts a new item in a **ComboBoxEx** control.
288+
Inserts a new item in a `ComboBoxEx` control.
289289

290290
```
291291
int InsertItem(const COMBOBOXEXITEM* pCBItem);
@@ -312,21 +312,21 @@ DWORD SetExtendedStyle(
312312

313313
### Parameters
314314
*dwExMask*
315-
A `DWORD` value that indicates which styles in *dwExStyles* are to be affected. Only the extended styles in *dwExMask* will be changed. All other styles will be maintained as is. If this parameter is zero, then all of the styles in *dwExStyles* will be affected.
315+
A DWORD value that indicates which styles in *dwExStyles* are to be affected. Only the extended styles in *dwExMask* will be changed. All other styles will be maintained as is. If this parameter is zero, then all of the styles in *dwExStyles* will be affected.
316316

317317
*dwExStyles*
318-
A `DWORD` value that contains the combo box control extended styles to set for the control.
318+
A DWORD value that contains the combo box control extended styles to set for the control.
319319

320320
### Return Value
321-
A `DWORD` value that contains the extended styles previously used for the control.
321+
A DWORD value that contains the extended styles previously used for the control.
322322

323323
### Remarks
324324
See [ComboBoxEx Control Extended Styles](http://msdn.microsoft.com/library/windows/desktop/bb775742) in the Windows SDK for more information about these styles.
325325

326326
To create a combo box extended control with extended windows styles, use [CreateEx](#createex).
327327

328328
## <a name="setimagelist"></a> CComboBoxEx::SetImageList
329-
Sets an image list for a **ComboBoxEx** control.
329+
Sets an image list for a `ComboBoxEx` control.
330330

331331
```
332332
CImageList* SetImageList(CImageList* pImageList);
@@ -337,15 +337,15 @@ CImageList* SetImageList(CImageList* pImageList);
337337
A pointer to a `CImageList` object containing the images to use with the `CComboBoxEx` control.
338338

339339
### Return Value
340-
A pointer to a [CImageList](../../mfc/reference/cimagelist-class.md) object containing the images previously used by the `CComboBoxEx` control. **NULL** if no image list was previously set.
340+
A pointer to a [CImageList](../../mfc/reference/cimagelist-class.md) object containing the images previously used by the `CComboBoxEx` control. NULL if no image list was previously set.
341341

342342
### Remarks
343343
This member function implements the functionality of the message [CBEM_SETIMAGELIST](http://msdn.microsoft.com/library/windows/desktop/bb775787), as described in the Windows SDK. If you change the height of the default edit control, call the Win32 function [SetWindowPos](http://msdn.microsoft.com/library/windows/desktop/ms633545) to resize your control after you call `SetImageList`, or it will not display properly.
344344

345345
The `CImageList` object pointed to by the return value is a temporary object and is destroyed during the next idle processing time.
346346

347347
## <a name="setitem"></a> CComboBoxEx::SetItem
348-
Sets the attributes for an item in a **ComboBoxEx** control.
348+
Sets the attributes for an item in a `ComboBoxEx` control.
349349

350350
```
351351
BOOL SetItem(const COMBOBOXEXITEM* pCBItem);

docs/mfc/reference/ccommandlineinfo-class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ BOOL m_bRunAutomated;
9999
```
100100

101101
### Remarks
102-
If `TRUE`, this means start up as an OLE automation server.
102+
If TRUE, this means start up as an OLE automation server.
103103

104104
## <a name="m_brunembedded"></a> CCommandLineInfo::m_bRunEmbedded
105105
Indicates that the `/Embedding` flag was found on the command line.
@@ -109,7 +109,7 @@ BOOL m_bRunEmbedded;
109109
```
110110

111111
### Remarks
112-
If `TRUE`, this means start up for editing an embedded OLE item.
112+
If TRUE, this means start up for editing an embedded OLE item.
113113

114114
## <a name="m_bshowsplash"></a> CCommandLineInfo::m_bShowSplash
115115
Indicates that the splash screen should be displayed.
@@ -119,7 +119,7 @@ BOOL m_bShowSplash;
119119
```
120120

121121
### Remarks
122-
If `TRUE`, this means the splash screen for this application should be displayed during startup. The default implementation of [ParseParam](#parseparam) sets this data member to `TRUE` if [m_nShellCommand](#m_nshellcommand) is equal to `CCommandLineInfo::FileNew`.
122+
If TRUE, this means the splash screen for this application should be displayed during startup. The default implementation of [ParseParam](#parseparam) sets this data member to TRUE if [m_nShellCommand](#m_nshellcommand) is equal to `CCommandLineInfo::FileNew`.
123123

124124
## <a name="m_nshellcommand"></a> CCommandLineInfo::m_nShellCommand
125125
Indicates the shell command for this instance of the application.
@@ -247,7 +247,7 @@ virtual void ParseParam(
247247
Indicates if this is the last parameter or flag on the command line.
248248

249249
### Remarks
250-
[CWinApp::ParseCommandLine](../../mfc/reference/cwinapp-class.md#parsecommandline) calls `ParseParam` once for each parameter or flag on the command line, passing the argument to *pszParam*. If the first character of the parameter is a ' **-**' or a ' **/**', then it is removed and *bFlag* is set to `TRUE`. When parsing the final parameter, *bLast* is set to `TRUE`.
250+
[CWinApp::ParseCommandLine](../../mfc/reference/cwinapp-class.md#parsecommandline) calls `ParseParam` once for each parameter or flag on the command line, passing the argument to *pszParam*. If the first character of the parameter is a ' **-**' or a ' **/**', then it is removed and *bFlag* is set to TRUE. When parsing the final parameter, *bLast* is set to TRUE.
251251

252252
The default implementation of this function recognizes the following flags: `/p`, `/pt`, `/dde`, `/Automation`, and `/Embedding`, as shown in the following table:
253253

@@ -267,7 +267,7 @@ virtual void ParseParam(
267267

268268
The default implementation puts the first non-flag parameter into [m_strFileName](#m_strfilename). In the case of the `/pt` flag, the default implementation puts the second, third, and fourth non-flag parameters into [m_strPrinterName](#m_strprintername), [m_strDriverName](#m_strdrivername), and [m_strPortName](#m_strportname), respectively.
269269

270-
The default implementation also sets [m_bShowSplash](#m_bshowsplash) to `TRUE` only in the case of a new file. In the case of a new file, the user has taken action involving the application itself. In any other case, including opening existing files using the shell, the user action involves the file directly. In a document-centric standpoint, the splash screen does not need to announce the application starting up.
270+
The default implementation also sets [m_bShowSplash](#m_bshowsplash) to TRUE only in the case of a new file. In the case of a new file, the user has taken action involving the application itself. In any other case, including opening existing files using the shell, the user action involves the file directly. In a document-centric standpoint, the splash screen does not need to announce the application starting up.
271271

272272
Override this function in your derived class to handle other flag and parameter values.
273273

docs/mfc/reference/ccommondialog-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ explicit CCommonDialog(CWnd* pParentWnd);
7171

7272
### Parameters
7373
*pParentWnd*
74-
Points to the parent or owner window object (of type [CWnd](../../mfc/reference/cwnd-class.md)) to which the dialog object belongs. If it is **NULL**, the dialog object's parent window is set to the main application window.
74+
Points to the parent or owner window object (of type [CWnd](../../mfc/reference/cwnd-class.md)) to which the dialog object belongs. If it is NULL, the dialog object's parent window is set to the main application window.
7575

7676
### Remarks
7777
See [CDialog::CDialog](../../mfc/reference/cdialog-class.md#cdialog) for complete information.

0 commit comments

Comments
 (0)