Glyphs Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Provides a visual representation of letters, characters, or symbols, in a specific font and style.
Inheritance Hierarchy
System.Object
System.Windows.DependencyObject
System.Windows.UIElement
System.Windows.FrameworkElement
System.Windows.Documents.Glyphs
Namespace: System.Windows.Documents
Assembly: System.Windows (in System.Windows.dll)
Syntax
'Declaration
Public NotInheritable Class Glyphs _
Inherits FrameworkElement
public sealed class Glyphs : FrameworkElement
<Glyphs .../>
The Glyphs type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") .gif "Supported by Silverlight for Windows Phone") |
ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) |
|
AllowDrop | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.) |
|
CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) |
|
Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
|
Cursor | Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.) |
|
DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) |
|
DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) |
|
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
|
Effect | Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.) |
|
Fill | Gets or sets the Brush that is used to render the glyphs. |
|
FlowDirection | Gets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.) |
|
FontRenderingEmSize | Gets or sets the font size used for rendering the glyphs. |
|
FontSource | Gets or sets the font source that is applied to the Glyphs for rendering content. |
|
FontUri | Gets or sets the location of the font used for rendering the glyphs. |
|
Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
HorizontalAlignment | Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.) |
|
Indices | Gets or sets the glyph indices for the glyphs. |
|
IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
|
Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
|
Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
Name | Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.) |
|
Opacity | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) |
|
OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) |
|
OriginX | Gets or sets the x origin for the glyphs. |
|
OriginY | Gets or sets the y origin for the glyphs. |
|
Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) |
|
Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) |
|
RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) |
|
RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) |
|
RenderTransformOrigin | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.) |
|
Resources | Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.) |
|
Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
|
StyleSimulations | Gets or sets the style simulations applied to the glyphs. |
|
Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) |
|
Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) |
|
UnicodeString | Gets or sets the Unicode string to render in glyphs. |
|
UseLayoutRounding | Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.) |
|
VerticalAlignment | Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.) |
|
Visibility | Gets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.) |
|
Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.) |
|
Arrange | Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.) |
.gif "Protected method") |
ArrangeOverride | Provides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.) |
|
CaptureMouse | Sets mouse capture to a UIElement. (Inherited from UIElement.) |
|
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
|
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) |
|
GetAnimationBaseValue | Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
|
GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
|
InvalidateArrange | Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.) |
|
InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.) |
|
Measure | Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.) |
|
MeasureOverride | Provides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnApplyTemplate | When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. (Inherited from FrameworkElement.) |
|
OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.) |
|
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
|
ReleaseMouseCapture | Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.) |
|
RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) |
|
SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
|
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.) |
|
UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) |
|
DataContextChanged | Occurs when the data context for this element changes. (Inherited from FrameworkElement.) |
|
DoubleTap | Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.) |
|
DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.) |
|
DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.) |
|
DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.) |
|
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.) |
|
GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) |
|
Hold | Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.) |
|
KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.) |
|
KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.) |
|
LayoutUpdated | Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.) |
|
Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) |
|
LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) |
|
LostMouseCapture | Occurs when the UIElement loses mouse capture. (Inherited from UIElement.) |
|
ManipulationCompleted | Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.) |
|
ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement.) |
|
ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.) |
|
MediaCommand | Occurs when a button is pressed on a remote control. (Inherited from UIElement.) |
|
MouseEnter | Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeave | Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeftButtonDown | Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
MouseLeftButtonUp | Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) |
|
MouseMove | Occurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.) |
|
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
MouseRightButtonUp | Occurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.) |
|
MouseWheel | Occurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.) |
|
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) |
|
Tap | Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.) |
|
TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) |
|
Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
FillProperty | Identifies the Fill dependency property. |
|
FontRenderingEmSizeProperty | Identifies the FontRenderingEmSize dependency property. |
|
FontUriProperty | Identifies the FontUri dependency property. |
|
IndicesProperty | Identifies the Indices dependency property. |
|
OriginXProperty | Identifies the OriginX dependency property. |
|
OriginYProperty | Identifies the OriginY dependency property. |
|
StyleSimulationsProperty | Identifies the StyleSimulations dependency property. |
|
UnicodeStringProperty | Identifies the UnicodeString dependency property. |
Top
Remarks
Glyphs is a low-level mechanism for rendering text that has been preformatted by a text layout and writing system engine, such as an XPS document. For all other scenarios, TextBlock should be used.
Glyphs does not have a content property (you do not define the glyphs by declaring text as the inner text of a Glyphs object element). Instead, you specify the individual glyphs by setting two properties:
UnicodeString—a string value that captures the Unicode in an XML-compatible encoding.
Indices—also a string, but this property uses a specialized mini-language that references glyphs by their font index order, and optionally specifies advance and offset spacings.
Usually, a glyphs element should be written with both the Indices and UnicodeString properties. The Indices property is used by rendering software to display the glyphs element on the screen or other device, while the UnicodeString property provides the original Unicode text for use by applications such as document viewers that support text search features, to allow their clients to copy text from the document to another application, or to support an accessibility screen reader. (There is no reliable general method to map from glyph indices to Unicode code points.)
If a glyphs element is to be used only for rendering, the UnicodeString property can be omitted. An application that includes its own text formatting code, complex script writing system code, and font fallback implementation might generate such glyphs elements, while providing its own support for search, copy/paste, and accessibility.
When the mapping of Unicode characters to glyph indices and positions is trivial, a glyphs element can set UnicodeString but not set Indices, as an optimization for XPS document size. In this case, the mapping from UTF-16 Unicode code point to glyph index must match the mappings specified in the font character map table, and the advance width of the character must be exactly that specified in the font hmtx table (scaled linearly by the font size). Additionally, as with any glyphs element, all the text must be rendered by the font file specified in FontUri. These restrictions severely limit text displayed this way. The following are the specific limitations of a glyphs element that has a Unicode string but no indices property:
Font fallback is not supported, and all characters must be supported by the specified font file.
Code points beyond U+ffff (surrogate code points, used for many East Asian characters) cannot be displayed.
Writing systems that require contextual substitution cannot be displayed. The following is a partial list of such systems:
Korean (Jamos)
Arabic, Farsi, Urdu, Syriac, Thaana
Hebrew
Thai, Lao, Khmer
Philippine (Tagalog, Hanunoo, Buhid, Tagbanwa)
Indic (Devanagari, Bangla, Gurmukhi, Gujarati, Odia, Tamil, Telugu, Kannada, Malayalam, Sinhala)
Tibetan
Limbu
Ethiopic
Mongolian
In addition to the glyph information, a Glyphs element must always specify a FontUri property value. There is no default or fallback characteristic that will provide a valid value. If you are defining Glyphs in XAML, a parser error will occur if you fail to specify a FontUri value or fail to specify any glyph information either by UnicodeString or GlyphIndex values in the Indices property.
One way to use Glyphs is with the XML Paper Specification (XPS) document format output of a document-producing application such as Microsoft Office Word 2007. The XPS format produces packages that define the document. One part of this package format is a XAML page that declares a FixedPage element defined by the XPS schema (this schema has the namespace https://schemas.microsoft.com/xps/2005/06). Glyphs is also an element of that schema. You can open up the package, find your FixedPage parts, extract the Glyphs from them, and paste the Glyphs into your XAML for Silverlight.
Note that the XPS Glyphs uses some attributes, such as BidiLevel, that are not part of the XAML subset for Silverlight, so you might have to remove some attributes before the transferred Glyphs is valid for Silverlight. Also, the transferred Glyphs will frequently reference a FontUri value already. The URI it references is another part of the XPS package, usually a font that is obfuscated, subsetted, and packaged explicitly for the XPS content that was authored. To use this same Glyphs in Silverlight, extract that font information from the XPS package, save it as a file with the appropriate extension, and make that font information available and downloadable as part of your application. Depending on your deployment and application structure, you might need to slightly adjust the path in the FontUri output from the original XPS. However, you cannot change the file name or extension of the obfuscated font file.
Another technique for obtaining the necessary parts to use Glyphs in Silverlight is to use the XPS printer driver that is a component of Windows Vista.
Note that the default Fill value for Glyphs is nulla null reference (Nothing in Visual Basic), and the default FontRenderingEmSize value is 0. Therefore, in order to render anything with Glyphs, you should specify working values either in XAML or script. This is in contrast to the TextBlock object, which has default values of Black and 11, respectively, for its analogous properties.
.gif "Note") Note: |
|---|
As with most types of software, font files are licensed, rather than sold, and licenses that govern the use of fonts vary from vendor to vendor. As a developer, it is your responsibility to ensure that you have the required license rights for any font you embed in a document or application, or otherwise redistribute. |
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
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.