property ClipPicture.Name as Variant
Indicates the picture to be used as a mask/clip.

TypeDescription
Variant

The Name property could be one of the following:

  • A String expression indicates:
    • a name of a picture file in the PicturePath folder. For instance, Name = "Layer1.png", loads the Layer1.png file if found in the PicturesPath folder.
    • a picture file including its absolute path. For instance, Name = "C:\Program Files\Exontrol\ExGauge\Sample\Design\Circular\Knob\Layer1.png", loads the Layer1.png file from absolute path
    • a key of the HTML picture, previously loaded by the HTMLPicture method. For instance, Name = "pic1", loads the HTML picture with the key pic1, so the pic1 should be load previously with a HTMLPicture call like HTMLPicture("pic1") = "C:\Program Files\Exontrol\ExGauge\Sample\Design\Circular\Knob\Layer1.png"
    • an encode BASE64 string of a picture file. The Exontrol's ExImages Tool encode/decode BASE64 strings from/to pictures. In this case, the string starts with "gB..", "gC.." and so on.
  • A Picture object that indicates the picture to be displayed. For instance, Name = LoadPicture("picture.jpg")
By default, the Name property is empty, so no clipping is applied. The picture being used as a clipping region must support transparency / alpha blending ( picture's attribute includes the PICTURE_TRANSPARENT ). For instance, you can use any PNG file with transparency. By default, the opaque-pixels in the picture defines the clipping region. Use the AlphaFrom / AlphaTo to include semi-transparent pixels in the clipping region. The DisplayAs property retrieves or sets a value that indicates the way how the graphic is arranged on the mask/clip.

To define a picture clip region over the layer you can use any of the following properties:

To specify the position / size of the picture clip object you can use any of the following properties:

To move the clipping region you can use any of the following properties:

If none of these properties are calling no clipping is applied to layer.

The following screen shot shows properties of the clipping objects relative to the layer:

The InverseClip property inverses the current clipping region, so anything that was included in the clipping region will be excluded, and reverse.