ImageEffect Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Drawing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the ImageEffect Class.

This class is available in Office 2010 and above.

When the object is serialized out as xml, it's qualified name is a14:imgEffect.

public class ImageEffect : DocumentFormat.OpenXml.OpenXmlCompositeElement

type ImageEffect = class
    inherit OpenXmlCompositeElement

Public Class ImageEffect
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

ImageEffect

Remarks

2.5.30 CT_PictureEffect

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

Referenced by: CT_PictureLayer

A complex type that specifies an effect applied to a picture. Exactly one child element MUST exist to specify the type of effect.

Child Elements:

artisticBlur: A CT_PictureEffectBlur element that specifies the blur picture effect.

artisticCement: A CT_PictureEffectCement element that specifies the cement picture effect.

artisticChalkSketch: A CT_PictureEffectChalkSketch element that specifies the chalk sketch picture effect.

artisticCrisscrossEtching: A CT_PictureEffectCrisscrossEtching element that specifies the crisscross etching picture effect.

artisticCutout: A CT_PictureEffectCutout element that specifies the cutout picture effect.

artisticFilmGrain: A CT_PictureEffectFilmGrain element that specifies the film grain picture effect.

artisticGlass: A CT_PictureEffectGlass element that specifies the glass picture effect.

artisticGlowDiffused: A CT_PictureEffectGlowDiffused element that specifies the glow diffused picture effect.

artisticGlowEdges: A CT_PictureEffectGlowEdges element that specifies the glow edges picture effect.

artisticLightScreen: A CT_PictureEffectLightScreen element that specifies the light screen picture effect.

artisticLineDrawing: A CT_PictureEffectLineDrawing element that specifies the line-drawing picture effect.

artisticMarker: A CT_PictureEffectMarker element that specifies the marker picture effect.

artisticMosiaicBubbles: A CT_PictureEffectMosiaicBubbles element that specifies the mosaic bubbles picture effect.

artisticPaintStrokes: A CT_PictureEffectPaintStrokes element that specifies the paint strokes picture effect.

artisticPaintBrush: A CT_PictureEffectPaintBrush element that specifies the paint-brush picture effect.

artisticPastelsSmooth: A CT_PictureEffectPastelsSmooth element that specifies the pastel smooth picture effect.

artisticPencilGrayscale: A CT_PictureEffectPencilGrayscale element that specifies the pencil grayscale picture effect.

artisticPencilSketch: A CT_PictureEffectPencilSketch element that specifies the pencil-sketch picture effect.

artisticPhotocopy: A CT_PictureEffectPhotocopy element that specifies the photocopy picture effect.

artisticPlasticWrap: A CT_PictureEffectPlasticWrap element that specifies the plastic wrap picture effect.

artisticTexturizer: A CT_PictureEffectTexturizer element that specifies the texture picture effect.

artisticWatercolorSponge: A CT_PictureEffectWatercolorSponge element that specifies the watercolor-sponge picture effect.

backgroundRemoval: A CT_PictureEffectBackgroundRemoval element that specifies the background-removal picture effect.

brightnessContrast: A CT_PictureEffectBrightnessContrast element that specifies the brightness and contrast picture effect.

colorTemperature: A CT_PictureEffectColorTemperature element that specifies the color-tone picture effect.

saturation: A CT_PictureEffectSaturation element that specifies the color-saturation picture effect.

sharpenSoften: A CT_PictureEffectSharpenSoften element that specifies the sharpen and soften picture effect.

Attributes:

visible: A Boolean attribute ([XMLSCHEMA2] section 3.2.2) that specifies whether this picture effect is rendered.

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

<xsd:complexType name="CT_PictureEffect">

<xsd:choice minOccurs="1" maxOccurs="1">

<xsd:element name="artisticBlur" type="CT_PictureEffectBlur" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticCement" type="CT_PictureEffectCement" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticChalkSketch" type="CT_PictureEffectChalkSketch" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticCrisscrossEtching" type="CT_PictureEffectCrisscrossEtching" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticCutout" type="CT_PictureEffectCutout" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticFilmGrain" type="CT_PictureEffectFilmGrain" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticGlass" type="CT_PictureEffectGlass" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticGlowDiffused" type="CT_PictureEffectGlowDiffused" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticGlowEdges" type="CT_PictureEffectGlowEdges" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticLightScreen" type="CT_PictureEffectLightScreen" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticLineDrawing" type="CT_PictureEffectLineDrawing" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticMarker" type="CT_PictureEffectMarker" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticMosiaicBubbles" type="CT_PictureEffectMosiaicBubbles" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPaintStrokes" type="CT_PictureEffectPaintStrokes" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPaintBrush" type="CT_PictureEffectPaintBrush" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPastelsSmooth" type="CT_PictureEffectPastelsSmooth" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPencilGrayscale" type="CT_PictureEffectPencilGrayscale" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPencilSketch" type="CT_PictureEffectPencilSketch" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPhotocopy" type="CT_PictureEffectPhotocopy" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticPlasticWrap" type="CT_PictureEffectPlasticWrap" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticTexturizer" type="CT_PictureEffectTexturizer" minOccurs="1" maxOccurs="1"/>

<xsd:element name="artisticWatercolorSponge" type="CT_PictureEffectWatercolorSponge" minOccurs="1" maxOccurs="1"/>

<xsd:element name="backgroundRemoval" type="CT_PictureEffectBackgroundRemoval" minOccurs="1" maxOccurs="1"/>

<xsd:element name="brightnessContrast" type="CT_PictureEffectBrightnessContrast" minOccurs="1" maxOccurs="1"/>

<xsd:element name="colorTemperature" type="CT_PictureEffectColorTemperature" minOccurs="1" maxOccurs="1"/>

<xsd:element name="saturation" type="CT_PictureEffectSaturation" minOccurs="1" maxOccurs="1"/>

<xsd:element name="sharpenSoften" type="CT_PictureEffectSharpenSoften" minOccurs="1" maxOccurs="1"/>

</xsd:choice>

<xsd:attribute name="visible" type="xsd:boolean" use="optional" default="true"/>

</xsd:complexType>

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

Constructors

ImageEffect()	Initializes a new instance of the ImageEffect class.
ImageEffect(IEnumerable<OpenXmlElement>)	Initializes a new instance of the ImageEffect class with the specified child elements.
ImageEffect(OpenXmlElement[])	Initializes a new instance of the ImageEffect class with the specified child elements.
ImageEffect(String)	Initializes a new instance of the ImageEffect class from outer XML.

Properties

ArtisticBlur	ArtisticBlur. Represents the following element tag in the schema: a14:artisticBlur.
ArtisticCement	ArtisticCement. Represents the following element tag in the schema: a14:artisticCement.
ArtisticChalkSketch	ArtisticChalkSketch. Represents the following element tag in the schema: a14:artisticChalkSketch.
ArtisticCrisscrossEtching	ArtisticCrisscrossEtching. Represents the following element tag in the schema: a14:artisticCrisscrossEtching.
ArtisticCutout	ArtisticCutout. Represents the following element tag in the schema: a14:artisticCutout.
ArtisticFilmGrain	ArtisticFilmGrain. Represents the following element tag in the schema: a14:artisticFilmGrain.
ArtisticGlass	ArtisticGlass. Represents the following element tag in the schema: a14:artisticGlass.
ArtisticGlowDiffused	ArtisticGlowDiffused. Represents the following element tag in the schema: a14:artisticGlowDiffused.
ArtisticGlowEdges	ArtisticGlowEdges. Represents the following element tag in the schema: a14:artisticGlowEdges.
ArtisticLightScreen	ArtisticLightScreen. Represents the following element tag in the schema: a14:artisticLightScreen.
ArtisticLineDrawing	ArtisticLineDrawing. Represents the following element tag in the schema: a14:artisticLineDrawing.
ArtisticMarker	ArtisticMarker. Represents the following element tag in the schema: a14:artisticMarker.
ArtisticMosaicBubbles	ArtisticMosaicBubbles. Represents the following element tag in the schema: a14:artisticMosiaicBubbles.
ArtisticPaintBrush	ArtisticPaintBrush. Represents the following element tag in the schema: a14:artisticPaintBrush.
ArtisticPaintStrokes	ArtisticPaintStrokes. Represents the following element tag in the schema: a14:artisticPaintStrokes.
ArtisticPastelsSmooth	ArtisticPastelsSmooth. Represents the following element tag in the schema: a14:artisticPastelsSmooth.
ArtisticPencilGrayscale	ArtisticPencilGrayscale. Represents the following element tag in the schema: a14:artisticPencilGrayscale.
ArtisticPencilSketch	ArtisticPencilSketch. Represents the following element tag in the schema: a14:artisticPencilSketch.
ArtisticPhotocopy	ArtisticPhotocopy. Represents the following element tag in the schema: a14:artisticPhotocopy.
ArtisticPlasticWrap	ArtisticPlasticWrap. Represents the following element tag in the schema: a14:artisticPlasticWrap.
ArtisticTexturizer	ArtisticTexturizer. Represents the following element tag in the schema: a14:artisticTexturizer.
ArtisticWatercolorSponge	ArtisticWatercolorSponge. Represents the following element tag in the schema: a14:artisticWatercolorSponge.
BackgroundRemoval	BackgroundRemoval. Represents the following element tag in the schema: a14:backgroundRemoval.
BrightnessContrast	BrightnessContrast. Represents the following element tag in the schema: a14:brightnessContrast.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ColorTemperature	ColorTemperature. Represents the following element tag in the schema: a14:colorTemperature.
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Saturation	Saturation. Represents the following element tag in the schema: a14:saturation.
SharpenSoften	SharpenSoften. Represents the following element tag in the schema: a14:sharpenSoften.
Visible	visible, this property is only available in Office 2010 and later. Represents the following attribute in the schema: visible
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)