Skip to content

Commit 17cd6ac

Browse files
author
mtx48109
committed
reformat-mfc-reference-pr8
1 parent ab97683 commit 17cd6ac

30 files changed

Lines changed: 662 additions & 662 deletions

‎docs/mfc/reference/cmfcribbonstatusbarpane-class.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ CMFCRibbonStatusBarPane(
106106
Specifies text string to be displayed on pane.
107107

108108
[in] *bIsStatic*
109-
If `TRUE`, the status pane cannot be highlighted or selected by clicking it.
109+
If TRUE, the status pane cannot be highlighted or selected by clicking it.
110110

111111
[in] *hIcon*
112112
Specifies a handle to an icon to be displayed on the pane.
@@ -160,7 +160,7 @@ BOOL IsAnimation() const;
160160
```
161161

162162
### Return Value
163-
`TRUE` if animation is in progress; `FALSE` otherwise.
163+
TRUE if animation is in progress; FALSE otherwise.
164164

165165
## <a name="isextended"></a> CMFCRibbonStatusBarPane::IsExtended
166166
Determine whether the pane is located in the extended area of the ribbon status bar.
@@ -170,7 +170,7 @@ BOOL IsExtended() const;
170170
```
171171

172172
### Return Value
173-
`TRUE` if pane is on status bar extended area. `FALSE` otherwise.
173+
TRUE if pane is on status bar extended area. FALSE otherwise.
174174

175175
## <a name="ondrawborder"></a> CMFCRibbonStatusBarPane::OnDrawBorder
176176
[!INCLUDE[cpp_fp_under_construction](../../mfc/reference/includes/cpp_fp_under_construction_md.md)]
@@ -251,7 +251,7 @@ BOOL SetAnimationList(
251251
Specifies the resource ID of the image list.
252252

253253
### Return Value
254-
`TRUE` if the image list is successfully attached to the status bar pane; `FALSE` otherwise.
254+
TRUE if the image list is successfully attached to the status bar pane; FALSE otherwise.
255255

256256
## <a name="settextalign"></a> CMFCRibbonStatusBarPane::SetTextAlign
257257
Sets the text alignment of the label of the status bar pane.
@@ -267,11 +267,11 @@ void SetTextAlign(int nAlign);
267267
### Remarks
268268
*nAlign* can have one of the following values:
269269

270-
- `TA_LEFT`: left alignment
270+
- TA_LEFT: left alignment
271271

272-
- `TA_CENTER:` center alignment
272+
- TA_CENTER: center alignment
273273

274-
- `TA_RIGHT:` right alignment
274+
- TA_RIGHT: right alignment
275275

276276
## <a name="startanimation"></a> CMFCRibbonStatusBarPane::StartAnimation
277277
Starts the animation that you assign to the pane.

‎docs/mfc/reference/cmfcribbonundobutton-class.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ virtual BOOL HasMenu() const;
129129
```
130130

131131
### Return Value
132-
Always returns `TRUE`.
132+
Always returns TRUE.
133133

134134
### Remarks
135135

‎docs/mfc/reference/cmfcshelllistctrl-class.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ virtual HRESULT DisplayFolder(LPAFX_SHELLITEMINFO lpItemInfo);
9090
A pointer to a `LPAFX_SHELLITEMINFO` structure that describes a folder to display.
9191

9292
### Return Value
93-
`S_OK` if successful; `E_FAIL` otherwise.
93+
S_OK if successful; E_FAIL otherwise.
9494

9595
## <a name="displayparentfolder"></a> CMFCShellListCtrl::DisplayParentFolder
9696
Updates the [CMFCShellListCtrl](../../mfc/reference/cmfcshelllistctrl-class.md) object to display the parent folder of the currently displayed folder.
@@ -100,7 +100,7 @@ virtual HRESULT DisplayParentFolder();
100100
```
101101

102102
### Return Value
103-
`S_OK` if successful; `E_FAIL` otherwise.
103+
S_OK if successful; E_FAIL otherwise.
104104

105105
## <a name="enableshellcontextmenu"></a> CMFCShellListCtrl::EnableShellContextMenu
106106
Enables the shortcut menu.
@@ -168,7 +168,7 @@ const IShellFolder* GetCurrentShellFolder() const;
168168
A pointer to the [IShellFolder Interface](http://msdn.microsoft.com/library/windows/desktop/bb775075) for the selected object.
169169

170170
### Remarks
171-
This method returns `NULL` if no object is currently selected.
171+
This method returns NULL if no object is currently selected.
172172

173173
## <a name="getitempath"></a> CMFCShellListCtrl::GetItemPath
174174
Retrieves the path for an item.
@@ -187,7 +187,7 @@ BOOL GetItemPath(
187187
The index of the list item.
188188

189189
### Return Value
190-
`TRUE` if successful; `FALSE` otherwise.
190+
TRUE if successful; FALSE otherwise.
191191

192192
### Remarks
193193
The index supplied by *iItem* is based on the items currently displayed by the [CMFCShellListCtrl Class](../../mfc/reference/cmfcshelllistctrl-class.md) object.
@@ -213,7 +213,7 @@ BOOL IsDesktop() const;
213213
```
214214

215215
### Return Value
216-
`TRUE` if the displayed folder is the desktop folder; `FALSE` otherwise.
216+
TRUE if the displayed folder is the desktop folder; FALSE otherwise.
217217

218218
## <a name="oncompareitems"></a> CMFCShellListCtrl::OnCompareItems
219219
[!INCLUDE[cpp_fp_under_construction](../../mfc/reference/includes/cpp_fp_under_construction_md.md)]
@@ -286,7 +286,7 @@ virtual int OnGetItemIcon(
286286
The item index.
287287

288288
[in] *pItem*
289-
A `LPAFX_SHELLITEMINFO` parameter that describes the item.
289+
A LPAFX_SHELLITEMINFO parameter that describes the item.
290290

291291
### Return Value
292292
The index of the icon image if successful; -1 if the function fails.
@@ -314,7 +314,7 @@ virtual CString OnGetItemText(
314314
The column of interest.
315315

316316
[in] *pItem*
317-
A `LPAFX_SHELLITEMINFO` parameter that describes the item.
317+
A LPAFX_SHELLITEMINFO parameter that describes the item.
318318

319319
### Return Value
320320
A `CString` that contains the text associated with the item.
@@ -332,7 +332,7 @@ virtual void OnSetColumns();
332332
```
333333

334334
### Remarks
335-
By default, the framework creates four columns in a `CMFCShellListCtrl` object. The names of these columns are `Name`, `Size`, `Type`, and `Modified`. You can override this method to customize the number of columns and their names.
335+
By default, the framework creates four columns in a `CMFCShellListCtrl` object. The names of these columns are **Name**, **Size**, **Type**, and **Modified**. You can override this method to customize the number of columns and their names.
336336

337337
## <a name="refresh"></a> CMFCShellListCtrl::Refresh
338338
Refreshes and repaints the [CMFCShellListCtrl](../../mfc/reference/cmfcshelllistctrl-class.md) object.

‎docs/mfc/reference/cmfcshelltreectrl-class.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ DWORD GetFlags() const;
8282
```
8383

8484
### Return Value
85-
A `DWORD` value that specifies the combination of flags currently set.
85+
A DWORD value that specifies the combination of flags currently set.
8686

8787
### Remarks
8888
The flags set in the `CMFCShellTreeCtrl` are sent to the method [IShellFolder::EnumObjects](http://msdn.microsoft.com/library/windows/desktop/bb775066) whenever the object is refreshed. You can change the flags with the [CMFCShellTreeCtrl::SetFlags](#setflags) method.
@@ -109,7 +109,7 @@ BOOL GetItemPath(
109109
### Remarks
110110
If this method fails, *strPath* contains the empty string.
111111

112-
If you do not specify *hTreeItem*, this method tries to obtain the string for the currently selected item. If no item is selected and *hTreeItem* is `NULL`, this method fails.
112+
If you do not specify *hTreeItem*, this method tries to obtain the string for the currently selected item. If no item is selected and *hTreeItem* is NULL, this method fails.
113113

114114
## <a name="getrelatedlist"></a> CMFCShellTreeCtrl::GetRelatedList
115115
Returns a pointer to the [CMFCShellListCtrl Class](../../mfc/reference/cmfcshelllistctrl-class.md) object that is associated with this [CMFCShellTreeCtrl](../../mfc/reference/cmfcshelltreectrl-class.md) object.
@@ -202,7 +202,7 @@ BOOL SelectPath(LPCITEMIDLIST lpidl);
202202
A PIDL that specifies the item
203203

204204
### Return Value
205-
`S_OK` if successful; `E_FAIL` otherwise.
205+
S_OK if successful; E_FAIL otherwise.
206206

207207
## <a name="setflags"></a> CMFCShellTreeCtrl::SetFlags
208208
Sets flags to filter the tree context.

‎docs/mfc/reference/cmfcstatusbar-class.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ void EnablePaneDoubleClick(BOOL bEnable=TRUE);
201201

202202
### Parameters
203203
[in] *bEnable*
204-
If `TRUE`, enable the processing of the mouse double-click. Otherwise disable the processing of the mouse double-click.
204+
If TRUE, enable the processing of the mouse double-click. Otherwise disable the processing of the mouse double-click.
205205

206206
### Remarks
207207
If the status bar is enabled to process double clicks, Windows sends the WM_COMMAND notification together with a resource ID to the owner of the status bar every time that the user double clicks on the status bar pane.
@@ -503,10 +503,10 @@ void SetPaneAnimation(
503503
Specifies the frame rate, in milliseconds, for the animation.
504504

505505
[in] *bUpdate*
506-
If `TRUE`, update the pane content immediately. Otherwise, the pane content is updated when it is invalidated.
506+
If TRUE, update the pane content immediately. Otherwise, the pane content is updated when it is invalidated.
507507

508508
### Remarks
509-
If you want to disable the current animation, call `SetPaneAnimation` with `hImageList` set to `NULL`.
509+
If you want to disable the current animation, call `SetPaneAnimation` with `hImageList` set to NULL.
510510

511511
## <a name="setpanebackgroundcolor"></a> CMFCStatusBar::SetPaneBackgroundColor
512512
Sets the background color of the status bar pane.
@@ -526,7 +526,7 @@ void SetPaneBackgroundColor(
526526
Specifies the new background color.
527527

528528
[in] *bUpdate*
529-
If `TRUE`, update the pane content immediately. Otherwise, do not update the pane content until the pane is invalidated by another method.
529+
If TRUE, update the pane content immediately. Otherwise, do not update the pane content until the pane is invalidated by another method.
530530

531531
## <a name="setpaneicon"></a> CMFCStatusBar::SetPaneIcon
532532
Set the icon of the status bar pane.
@@ -562,7 +562,7 @@ void SetPaneIcon(
562562
Specifies the transparent color of the bitmap that the *hBmp* indicates.
563563

564564
### Remarks
565-
You can pass either `HICON` or `HBITMAP` together with the transparent color to set the pane's image. If you do not want to display the image any longer, pass the `NULL` value as the image handle.
565+
You can pass either HICON or HBITMAP together with the transparent color to set the pane's image. If you do not want to display the image any longer, pass the NULL value as the image handle.
566566

567567
If there is any running animation that [CMFCStatusBar::SetPaneAnimation](#setpaneanimation) has set, the animation will be stopped.
568568

@@ -662,7 +662,7 @@ void SetPaneTextColor(
662662
Specifies the text color.
663663

664664
[in] *bUpdate*
665-
If `TRUE`, update the pane content immediately. Otherwise, do not update the pane content until the pane is invalidated by another method.
665+
If TRUE, update the pane content immediately. Otherwise, do not update the pane content until the pane is invalidated by another method.
666666

667667
## <a name="setpanewidth"></a> CMFCStatusBar::SetPaneWidth
668668
Set the width of the status bar pane.

0 commit comments

Comments
 (0)