GradientStop Class

Gradient stops.When the object is serialized out as xml, its qualified name is a:gs.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.GradientStop

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(HslColor))> _
<ChildElementInfoAttribute(GetType(SystemColor))> _
<ChildElementInfoAttribute(GetType(SchemeColor))> _
<ChildElementInfoAttribute(GetType(RgbColorModelHex))> _
<ChildElementInfoAttribute(GetType(RgbColorModelPercentage))> _
<ChildElementInfoAttribute(GetType(PresetColor))> _
Public Class GradientStop _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As GradientStop
[ChildElementInfoAttribute(typeof(HslColor))]
[ChildElementInfoAttribute(typeof(SystemColor))]
[ChildElementInfoAttribute(typeof(SchemeColor))]
[ChildElementInfoAttribute(typeof(RgbColorModelHex))]
[ChildElementInfoAttribute(typeof(RgbColorModelPercentage))]
[ChildElementInfoAttribute(typeof(PresetColor))]
public class GradientStop : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • RgbColorModelPercentage <a:scrgbClr>

  • RgbColorModelHex <a:srgbClr>

  • HslColor <a:hslClr>

  • SystemColor <a:sysClr>

  • SchemeColor <a:schemeClr>

  • PresetColor <a:prstClr>

[ISO/IEC 29500-1 1st Edition]

20.1.8.36 gs (Gradient stops)

This element defines a gradient stop. A gradient stop consists of a position where the stop appears in the color band.

Parent Elements

gsLst (§20.1.8.37)

Child Elements

Subclause

hslClr (Hue, Saturation, Luminance Color Model)

§20.1.2.3.13

prstClr (Preset Color)

§20.1.2.3.22

schemeClr (Scheme Color)

§20.1.2.3.29

scrgbClr (RGB Color Model - Percentage Variant)

§20.1.2.3.30

srgbClr (RGB Color Model - Hex Variant)

§20.1.2.3.32

sysClr (System Color)

§20.1.2.3.33

Attributes

Description

pos (Position)

Specifies where this gradient stop should appear in the color band. This position is specified in the range [0%, 100%], which corresponds to the beginning and the end of the color band respectively.

The possible values for this attribute are defined by the ST_PositiveFixedPercentage simple type (§20.1.10.45).

[Note: The W3C XML Schema definition of this element’s content model (CT_GradientStop) is located in §A.4.1. end note]

© ISO/IEC29500: 2008.

Thread Safety

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

See Also

Reference

GradientStop Members

DocumentFormat.OpenXml.Drawing Namespace