<PageScale> element

  • Article

<PageScale> element

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Specifies the value of the default page unit in the current drawing scale. The drawing scale for the page is the ratio of the page unit in the PageScale element to the drawing unit shown in the DrawingScale element.

Syntax

  <PageScale

      [Unit = "unitval"]

      [F = "formula"]

      [Err = "error"]>

  </PageScale>

Attributes

Unit

Optional string. Represents a unit of measure. The default is NUM. For details about NUM, see Units of measure.

F

Optional string. Represents the element's formula. This attribute can contain the string "someFormula" if the formula exists locally, "No Formula" if the formula is locally deleted or blocked, or "Inh" if the formula is inherited.

If the attribute is not present, the element's formula is a simple constant, for example, <element> 5 </element>.

Err

Optional string. Indicates that the formula evaluates to an error. The value of Err is the current value (an error message string); the value of the element is the last valid value.

Element information

Parent elements:

PageProps

Child elements:

None

Remarks

The default unit for the PageScale element is NUM. In practice, however, you should always specify the default page unit as an explicit unit, so a Unit attribute is always saved out. For example, if default page unit is inches, then <PageScale Unit="IN_F"> will be saved in the XML for Visio file.

The PageScale element is relevant only when contained in a PageSheet element. It is ignored when contained in a DocumentSheet, Shape, or StyleSheet element.

Example

In the following example, the drawing scale has been specified as 3/32" = 1'0". The value in the PageScale element is 0.09375 inches (or 3/32") and the value in the DrawingScale element is 12 inches (or 1'0").

Also, the PageScale element has a Unit attribute of "IN_F". Any element on this page that has a Unit attribute of "DP" (or no Unit attribute specified, but a default Unit attribute of "DP") will use "IN_F" for its Unit attribute.

The example has been excerpted for clarity.

  <PageProps>
<PageScale Unit="IN_F">0.09375</PageScale><DrawingScale Unit="F_I">12</DrawingScale><DrawingSizeType>0</DrawingSizeType><DrawingScaleType>1</DrawingScaleType></PageProps>

See also

PageScale cell (Page Properties section)