The syntax shown in this documentation follows these guidelines. Each property, method and event is shown for C# (C#), Visual Basic .NET (VB.NET), Visual C++ (C++) and C (C).
The syntax for properties shows up to three forms (Get, Put and PutRef) if available, the first to retrieve the property value, the second and third to set the property value. For most properties, only a Get and Put syntax is shown. Font and picture properties also allow a third form (PutRef). If both Put and PutRef are available,PutRef is the preferred form as it conserves resources and assigns a font or picture object reference to the control. Any change to the font or picture object is reflected in the control also. Put on the other hand causes the control to completely copy the font or picture object.
Get
| C# | stdole.IPictureDisp refPictureObj = object.Picture; |
| VB.NET | refPictureObj = object.Picture As stdole.IPictureDisp |
| C++ | IPictureDisp* refPictureObj = object->GetPicture(); |
| C | HRESULT object->get_Picture(IPictureDisp** refPictureObj); |
Put
| C# | void object.let_Picture(stdole.IPictureDisp refPictureObj); |
| VB.NET | object.let_Picture(ByVal refPictureObj As stdole.IPictureDisp) |
| C++ | void object->PutPicture(IPictureDisp* refPictureObj); |
| C | HRESULT object->put_Picture(IPictureDisp* refPictureObj); |
PutRef
| C# | stdole.IPictureDisp object.Picture = refPictureObj; |
| VB.NET | object.Picture = refPictureObj As stdole.IPictureDisp |
| C++ | void object->PutRefPicture(IPictureDisp* refPictureObj); |
| C | HRESULT object->putref_Picture(IPictureDisp* refPictureObj); |
If the
indicator is shown next to a type, it links to additional language-specific help.
The following conventions are used throughout the reference section:
| Description | Example |
|---|---|
| Syntax shown shows sample use of the property, method or event (C#, VB.NET) or shows its definition (C++, C) | refPictureObj = object.Picture |
| Syntax shown in this color shows the type of the property, return type of the method or event (C#, VB.NET) | As stdole.IPictureDisp : IPictureDisp |
| Words in bold (any color) indicate language keywords or (property, method, event) names. | False If Function BorderStyle |
| Italic words (any color) indicate placeholders for information, to be supplied by you. | object index var |
| Words in regular font (any color) indicate text that is used as-is, such as language specific punctuation. | -> get_ |
| Square brackets (any color) indicate array indices. | [, arg] |
The code examples shown for properties, methods and events are available for C#, VB.NET and C++. Complete sample applications can be found in the product directory \Program Files (x86)\Softelvdm\SftMask OCX 8.0\Samples\.