TextEffect Class
Defines the TextEffect Class.When the object is serialized out as xml, its qualified name is w:effect.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.TextEffect
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class TextEffect _
Inherits OpenXmlLeafElement
'Usage
Dim instance As TextEffect
public class TextEffect : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.3.2.11 effect (Animated Text Effect)
This element specifies an animated text effect which should be displayed when rendering the contents of this run. This effect is rendered around the extents of the text in the run in the same location as a run border with zero pixels of padding would be rendered (if such a run border was present).
If this element is not present, the default value is to leave the formatting applied at previous level in the style hierarchy. If this element is never applied in the style hierarchy, then no text effect shall be applied to the contents of this run.
[Example: Consider a run of text which must have an animated text effect consisting of multiple colored flashing lights (see possible attribute values for descriptions of each effect). This constraint is specified using the following WordprocessingML:
<w:rPr> <w:effect w:val="lights"/> </w:rPr>
This run explicitly declares that the effect property is lights, so the contents of this run has an animated lights text effect. end example]
Parent Elements |
|---|
rPr (§17.3.1.29); rPr (§17.3.1.30); rPr (§17.5.2.28); rPr (§17.9.25); rPr (§17.7.9.1); rPr (§17.7.5.4); rPr (§17.3.2.28); rPr (§17.5.2.27); rPr (§17.7.6.2); rPr (§17.3.2.27) |
Attributes |
Description |
|---|---|
val (Animated Text Effect Type) |
Specifies the type of animated text effect which shall be applied to this text run. [Example: Consider a run of text which must have an animated text effect consisting of multiple colored flashing lights. This constraint is specified using the following WordprocessingML: <w:rPr> <w:effect w:val="lights"/> </w:rPr> This run explicitly declares a type of text effect, using the val property, of lights, so the contents of this run has the animated lights text effect. end example] The possible values for this attribute are defined by the ST_TextEffect simple type (§17.18.94). |
[Note: The W3C XML Schema definition of this element’s content model (CT_TextEffect) is located in §A.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.