Stone_Red/docs-desktop
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/docs-desktop.git synced 2026-09-07 23:43:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update defining-default-values-with-the-shouldserialize-and-reset-methods.md (#34)

Browse Source 
* Update defining-default-values-with-the-shouldserialize-and-reset-methods.md

Make the methods private as those are invoked by convention.

* Update dotnet-desktop-guide/framework/winforms/controls/defining-default-values-with-the-shouldserialize-and-reset-methods.md

Co-authored-by: Andy De George <[email protected]>

Co-authored-by: Andy De George <[email protected]>
This commit is contained in:
Igor Velikorossov
2020-09-09 22:34:07 -07:00
committed by GitHub
co-authored by Andy De George
parent 6cc5bca37c
commit 76317373cc
1 changed files with 18 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dotnet-desktop-guide/framework/winforms/controls/defining-default-values-with-the-shouldserialize-and-reset-methods.md
+18 -12
View File
@@ -18,19 +18,22 @@ ms.assetid: 7b6c5e00-3771-46b4-9142-5a80d5864a5e
- The designer generates more efficient code. - The designer generates more efficient code.
> [!NOTE] > [!NOTE]
> Either apply the <xref:System.ComponentModel.DefaultValueAttribute> or provide `Reset`*PropertyName* and `ShouldSerialize`*PropertyName* methods. Do not use both. > Either apply the <xref:System.ComponentModel.DefaultValueAttribute> or provide `Reset`*PropertyName* and `ShouldSerialize`*PropertyName* methods. Do not use both.
When declaring a `ShouldSerialize` or `Reset` method, use the `private` access modifier. These methods are usually invoked by the designer and not by user code.
The `Reset`*PropertyName* method sets a property to its default value, as shown in the following code fragment. The `Reset`*PropertyName* method sets a property to its default value, as shown in the following code fragment.
```vb ```vb
Public Sub ResetMyFont() Private Sub ResetMyFont()
MyFont = Nothing MyFont = Nothing
End Sub End Sub
``` ```
```csharp ```csharp
public void ResetMyFont() { private void ResetMyFont()
{
MyFont = null; MyFont = null;
} }
``` ```
@@ -43,15 +46,16 @@ public void ResetMyFont() {
```vb ```vb
'Returns true if the font has changed; otherwise, returns false. 'Returns true if the font has changed; otherwise, returns false.
' The designer writes code to the form only if true is returned. ' The designer writes code to the form only if true is returned.
Public Function ShouldSerializeMyFont() As Boolean Private Function ShouldSerializeMyFont() As Boolean
Return Not (thefont Is Nothing) Return thefont IsNot Nothing
End Function End Function
``` ```
```csharp ```csharp
// Returns true if the font has changed; otherwise, returns false. // Returns true if the font has changed; otherwise, returns false.
// The designer writes code to the form only if true is returned. // The designer writes code to the form only if true is returned.
public bool ShouldSerializeMyFont() { private bool ShouldSerializeMyFont()
{
return thefont != null; return thefont != null;
} }
``` ```
@@ -90,11 +94,11 @@ Public Class MyControl
End Set End Set
End Property End Property
Public Function ShouldSerializeMyFont() As Boolean Private Function ShouldSerializeMyFont() As Boolean
Return Not (thefont Is Nothing) Return thefont IsNot Nothing
End Function End Function
Public Sub ResetMyFont() Private Sub ResetMyFont()
MyFont = Nothing MyFont = Nothing
End Sub End Sub
End Class End Class
@@ -124,11 +128,13 @@ public class MyControl : Control {
} }
} }
public bool ShouldSerializeMyFont() { private bool ShouldSerializeMyFont()
{
return thefont != null; return thefont != null;
} }
public void ResetMyFont() { private void ResetMyFont()
{
MyFont = null; MyFont = null;
} }
} }