- Notifications
You must be signed in to change notification settings - Fork1.6k
Summary: Property
Maira Wenzel edited this pageApr 24, 2019 ·3 revisions
The following table provides wording guidelines and boilerplate text for Summary sections in property pages.
An indexer is the C# term for an indexed property. An indexer takes a parameter that indexes the value of the property. In C#, an indexer is defined with thethis keyword. For example:
public string this[int index]. In Visual Basic, an indexer is equivalent to a default indexed property named Item.
| Item | Wording | Examples |
|---|---|---|
| Read/write property or indexer | Boolean: Gets or sets a value that indicates whether<condition>. Other: Gets or sets<summary without specifying the type>. | Control.AllowDropproperty summary: Gets or sets a value that indicates whether the control can accept data that the user drags onto it. Control.BackColorproperty summary: Gets or sets the background color for the control. |
| Read-only property or indexer | Boolean: Gets a value that indicates whether<condition>. Other: Gets<summary without specifying the type>. Note: It isn't necessary to say "This property is read-only." | Type.IsByRef property summary: Gets a value that indicates whether theType is passed by reference. Type.DefaultBinderproperty summary: Gets the default binder used by the system. |
| Explicit interface property implementation | <Copy from the interface member if appropriate> |