clip property

Article
05/02/2017

Specifies which part of a positioned object is visible.

This property is read/write.

Syntax

HRESULT put_clip(
                BSTR v
);

HRESULT get_clip(
  [out, retval] BSTR *sClip = auto
);

Property values

Type: BSTR

auto (auto)

Default. Clip to expose entire object.

rect(top, right, bottom, left) (rect(top, right, bottom, left))

Top, right, bottom, and left specify length values, any of which can be replaced by auto, leaving that side not clipped. The value of top specifies that everything above this value on the Y axis (with 0 at the top) is clipped. The value of right specifies that everything above this value on the X axis (with 0 at the left) is clipped. The value of bottom specifies that everything below this value on the Y axis (with 0 at the top) is clipped. The value of left specifies that everything to the left of this value on the X axis (with 0 at the left) is clipped.

String format

auto | rect(top, right, bottom, left)

CSS information

Applies To	absolutely positioned elements
Media	visual
Inherited	no
Initial Value	auto

Standards information

CSS 2.1, Section 11.1.2

Remarks

This property defines the shape and size of the positioned object that is visible. The IHTMLCSSStyleDeclaration::position must be set to absolute. Any part of the object that is outside the clipping region is transparent. Any coordinate can be replaced by the value auto, which exposes the respective side (that is, the side is not clipped).

The order of the values in "clip:rect(0, 0, 50, 50)" renders the object invisible because it sets the top and right positions of the clipping region to 0. To achieve a 50-by-50 view port, use "clip:rect(0, 50, 50, 0)".

Starting in Windows Internet Explorer 8, the required syntax of the IHTMLCSSStyleDeclaration::clip property is identical to that specified in the Cascading Style Sheets, Level 2 Revision 1 (CSS2.1) specification; that is, commas are now required between the parameters of the rect() value. This behavior requires Windows Internet Explorer to be in IE8 Standards mode or higher. For more information on document compatibility modes, see Defining Document Compatibility.

In Windows Internet Explorer 7 and earlier (and in Internet Explorer 8 or later in IE7 Standards mode, EmulateIE7 mode, or IE5 (Quirks) mode), the commas should be omitted. For example: "clip:rect(0 50 50 0)"

The required syntax of the IHTMLCSSStyleDeclaration::clip attribute is identical to that specified in the CSS2.1 specification; that is, commas are required between the parameters of the rect() value.

Examples

This example uses the IHTMLCSSStyleDeclaration::clip property to clip an image of a sphere from the left, right, top, and bottom.

.clipLeft {
   position: absolute;
   top: 40px;
   left: 0;
   clip: rect(auto, auto, auto, 20px);
}
.clipRight {
   position: absolute;
   top: 40px;
   left: 100px;
   clip: rect(auto, 60px, auto, auto);
}
.clipTop {
   position: absolute;
   top: 40px;
   left: 200px;
   clip: rect(20px, auto, auto, auto);
}
.clipBottom {
   position: absolute;
   top: 40px;
   left: 300px;
   clip: rect(auto, auto, 60px, auto);
}

<body>
  <div class="clipLeft">
    <img src="sphere.jpg">
  </div>
  <div class="clipRight">
    <img src="sphere.jpg">
  </div>
  <div class="clipTop">
    <img src="sphere.jpg">
  </div>  
  <div class="clipBottom">
    <img src="sphere.jpg">
  </div>
</body>

The following image shows the result. The sphere image is clipped from the left, right, top, and bottom:

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
Header	Mshtml.h
IDL	Mshtml.idl
DLL	Mshtml.dll

Share via