SetOptions Method (IUserOptionsPropertyPage)

Top  Previous  Next

This method is called by MZ-Tools when the property page must retrieve values from the user interface controls and set the values of the UserOptions class or derived class.

Signature

[VB.NET]

Sub SetOptions(ByVal userOptions As UserOptions, ByRef cancel As Boolean, ByRef cancellationReason As String)

[C#]

void SetOptions(UserOptions userOptions, ref bool cancel, ref string cancellationReason)

Parameters

  • userOptions: the instance of a UserOptions class (or derived class) that the operation is using.
  • cancel: if the method returns true in this parameter, the retrieval of values is cancelled. Typically this can happen if some value is not valid.
  • cancellationReason: message that will be shown to the user about the cancellation.