Property Set Statement

Office VBScript

Microsoft® Visual Basic® Scripting Edition Property Set Statement  Language Reference 
Version 5 


Description
Declares, in a Class block, the name, arguments, and code that form the body of a Property procedure that sets a reference to an object.
Syntax
[Public | Private] Property Set name([arglist,] reference)
    [statements]
    [Exit Property]
    [statements]
End Property

The Property Set statement syntax has these parts:

Part Description
Public Indicates that the Property Set procedure is accessible to all other procedures in all scripts.
Private Indicates that the Property Set procedure is accessible only to other procedures in the Class block where it's declared.
name Name of the Property Set procedure; follows standard variable naming conventions, except that the name can be the same as a Property Get or Property Let procedure in the same Class block.
arglist List of variables representing arguments that are passed to the Property Set procedure when it is called. Multiple arguments are separated by commas. In addition, the Property Set procedure will always have one more argument than its corresponding Property Get procedure. That argument is the object being assigned to the property.
reference Variable containing the object reference used on the right side of the object reference assignment.
statements Any group of statements to be executed within the body of the Property Set procedure.


NoteVersion Version Every Property Set statement must define at least one argument for the procedure it defines. That argument (or the last argument if there is more than one) contains the actual object reference for the property when the procedure defined by the Property Set statement is invoked. That argument is referred to as reference in the preceding syntax.

Remarks
If not explicitly specified using either Public or Private, Property Set procedures are public by default, that is, they are visible to all other procedures in your script. The value of local variables in a Property Set procedure is not preserved between calls to the procedure.

You can't define a Property Set procedure inside any other procedure (e.g. Function or Property Let).

The Exit Property statement causes an immediate exit from a Property Set procedure. Program execution continues with the statement that follows the statement that called the Property Set procedure. Any number of Exit Property statements can appear anywhere in a Property Set procedure.

Like a Function and Property Get procedure, a Property Set procedure is a separate procedure that can take arguments, perform a series of statements, and change the value of its arguments. However, unlike a Function and Property Get procedure, both of which return a value, you can only use a Property Set procedure on the left side of an object reference assignment (Set statement).