CameraTool class

Office 2013 and later

Defines the CameraTool Class.This class is available in Office2010 or above. When the object is serialized out as xml, its qualified name is a14:cameraTool.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Office2010.Drawing.CameraTool

Namespace:  DocumentFormat.OpenXml.Office2010.Drawing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class CameraTool : OpenXmlLeafElement

2.3.19 cameraTool

Target namespace: http://schemas.microsoft.com/office/drawing/2010/main

A CT_CameraTool element that specifies that a picture, as defined by the pic element as specified in [ISO/IEC-29500-1] section 20.2.2.5, is a camera object. A camera object is a picture that shows a live view of a cell range in the specified spreadsheet, including any graphic objects contained in the cell range and all formatting applied to the contents of the cell range. Updates to the contents of the cell range are reflected in the camera object. Shape properties, such as the position and size of the camera object, are defined by the parent pic element. The view of the cell range MUST be a rectangle. The view of the cell range MUST scale vertically and horizontally to fill the rectangle exactly.

See section 2.2.6.1 for information about how this element is integrated with the Open XML file formats as specified in- [ISO/IEC-29500:2008].

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="cameraTool" type="CT_CameraTool"/>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.5.71 CT_CameraTool

Target namespace: http://schemas.microsoft.com/office/drawing/2010/main

Referenced by: cameraTool

A complex type that specifies camera tool properties.

Attributes:

cellRange: An xsd:string ([XMLSCHEMA2] section 3.2.1) that uses standard cell reference syntax as specified in [ISO/IEC-29500-1] section 18.17.2.3. This specifies the cell range of the camera tool. The cell range MUST use the A1 style reference, instead of the R1C1 reference. The cell range MUST be used when defining the camera tool.

spid: An xsd:string ([XMLSCHEMA2] section 3.2.1) that specifies the shape identifier of a legacy drawing object. If string is "0" there is no legacy shape. However the legacy drawing object MUST be deleted if the current drawing element is to be used. Otherwise, two camera tool objects are present.

This string has the following characteristics:

If string is not the default value it MUST begin with "_x0000_" followed by one character and a number that specifies the identifier: _x0000_[c]<shape id>

The character [c] MUST be set to ‘s’.

Shape identifiers MUST be in the range from 1025 through 268435456.

Shape identifiers are clustered, and each cluster has 1024 values. The first cluster ranges from 1025 through 2048.

Shape identifiers in the same cluster SHOULD only exist in one worksheet.

It MUST NOT contain Numeric Character Reference (NCR) characters.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_CameraTool">

<xsd:attribute name="cellRange" type="xsd:string"/>

<xsd:attribute name="spid" use="optional" default="0" type="xsd:string"/>

</xsd:complexType>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: