Span Class

Definition

Represents a section of a FormattedString.

[Xamarin.Forms.ContentProperty("Text")]
public class Span : Xamarin.Forms.GestureElement, Xamarin.Forms.IDecorableTextElement, Xamarin.Forms.Internals.IFontElement
type Span = class
    inherit GestureElement
    interface IFontElement
    interface IDecorableTextElement
Inheritance
Attributes
Implements

Remarks

Bindings to Span properties are OneTime by default.

Constructors

Span()

Initialize a new instance of the Span class.

Fields

BackgroundColorProperty

Backing store for the BackgroundColor property.

CharacterSpacingProperty
FontAttributesProperty

Backing store for the FontAttributes property.

FontFamilyProperty

Backing store for the FontFamily property.

FontProperty

Backing store for the Font property.

FontSizeProperty

Backing store for the FontSize property.

ForegroundColorProperty
Obsolete.

Backing store for the ForegroundColor property.

LineHeightProperty

Backing store for the LineHeight bindable property.

StyleProperty

Backing store for the Style property.

TextColorProperty

Backing store for the TextColor property.

TextDecorationsProperty

The BindableProperty associated with the TextDecorations property.

TextProperty

Backing store for the Text property.

TextTransformProperty

Properties

AutomationId

Gets or sets a value that allows the automation framework to find and interact with this element.

(Inherited from Element)
BackgroundColor

Gets or sets the Color of the span background.

BindingContext

Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject.

(Inherited from BindableObject)
CharacterSpacing
ClassId

Gets or sets a value used to identify a collection of semantically similar elements.

(Inherited from Element)
Dispatcher (Inherited from BindableObject)
EffectControlProvider

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Effects

A list of the effects that are applied to this item.

(Inherited from Element)
Font
Obsolete.

Gets or sets the Font for the text in the span.

FontAttributes

Gets a value that indicates whether the font for the span is bold, italic, or neither.

FontFamily

Gets the font family to which the font for the text in the span belongs.

FontSize

Gets the size of the font for the text in the span.

ForegroundColor

Gets or sets the Color for the text in the span.

GestureRecognizers

Gets the list of recognizers that belong to the element.

(Inherited from GestureElement)
Id

Gets a value that can be used to uniquely identify an element through the run of an application.

(Inherited from Element)
LineHeight

Gets or sets the multiplier to apply to the default line height when displaying text.

LogicalChildren

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Parent

Gets or sets the parent element of the element.

(Inherited from Element)
ParentView
Obsolete.

Gets the element which is the closest ancestor of this element that is a VisualElement.

(Inherited from Element)
Platform
Obsolete.
(Inherited from Element)
RealParent

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Style

Gets or sets the Style to apply to the span.

StyleId

Gets or sets a user defined value to uniquely identify the element.

(Inherited from Element)
Text

Gets or sets the text of the span.

TextColor

Gets or sets the text color.

TextDecorations

Gets or sets the TextDecorations applied to this span.

TextTransform

Methods

ApplyBindings()

Apply the bindings to BindingContext.

(Inherited from BindableObject)
ClearValue(BindableProperty)

Clears any value set by SetValue for property.

(Inherited from BindableObject)
ClearValue(BindablePropertyKey)

Clears any value set by SetValue for the property that is identified by propertyKey.

(Inherited from BindableObject)
CoerceValue(BindableProperty) (Inherited from BindableObject)
CoerceValue(BindablePropertyKey) (Inherited from BindableObject)
Descendants()

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
EffectIsAttached(String)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
FindByName(String)

Returns the element that has the specified name.

(Inherited from Element)
GetValue(BindableProperty)

Returns the value that is contained in the BindableProperty.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty)
Obsolete.

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty)
Obsolete.

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
IsSet(BindableProperty)

Returns true if the target property exists and has been set.

(Inherited from BindableObject)
OnBindingContextChanged()

Override this method to execute an action when the BindingContext changes.

OnChildAdded(Element)

Invoked whenever the ChildAdded event needs to be emitted. Implement this method to add class handling for this event.

(Inherited from Element)
OnChildRemoved(Element)
Obsolete.

Invoked whenever the ChildRemoved event needs to be emitted. Implement this method to add class handling for this event.

(Inherited from Element)
OnChildRemoved(Element, Int32) (Inherited from Element)
OnParentSet()

Invoked whenever the Parent of an element is set. Implement this method in order to add behavior when the element is added to a parent.

(Inherited from Element)
OnPropertyChanged(String)

Method that is called when a bound property is changed.

(Inherited from Element)
OnPropertyChanging(String)

Call this method from a child class to notify that a change is going to happen on a property.

(Inherited from BindableObject)
RemoveBinding(BindableProperty)

Removes a previously set binding.

(Inherited from BindableObject)
RemoveDynamicResource(BindableProperty)

Removes a previously set dynamic resource

(Inherited from Element)
SetBinding(BindableProperty, BindingBase)

Assigns a binding to a property.

(Inherited from BindableObject)
SetDynamicResource(BindableProperty, String)

Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key.

(Inherited from Element)
SetValue(BindableProperty, Object)

Sets the value of the specified property.

(Inherited from BindableObject)
SetValue(BindablePropertyKey, Object)

Sets the value of the propertyKey.

(Inherited from BindableObject)
SetValueCore(BindableProperty, Object, SetValueFlags)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
UnapplyBindings()

Unapplies all previously set bindings.

(Inherited from BindableObject)
UpdateFormsText(String, TextTransform)

Events

BindingContextChanged

Raised whenever the BindingContext property changes.

(Inherited from BindableObject)
ChildAdded

Occurs whenever a child element is added to the element.

(Inherited from Element)
ChildRemoved

Occurs whenever a child element is removed from the element.

(Inherited from Element)
DescendantAdded

Occurs whenever a child element is added to the elements subtree.

(Inherited from Element)
DescendantRemoved

Occurs whenever a child element is removed from the elements subtree.

(Inherited from Element)
PlatformSet
Obsolete.
(Inherited from Element)
PropertyChanged

Raised when a property has changed.

(Inherited from BindableObject)
PropertyChanging

Raised when a property is about to change.

(Inherited from BindableObject)

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
IElementController.SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
IFontElement.FontSizeDefaultValueCreator()

For internal use by the Xamarin.Forms platform.

IFontElement.OnFontAttributesChanged(FontAttributes, FontAttributes)

For internal use by the Xamarin.Forms platform.

IFontElement.OnFontChanged(Font, Font)

For internal use by the Xamarin.Forms platform.

IFontElement.OnFontFamilyChanged(String, String)

For internal use by the Xamarin.Forms platform.

IFontElement.OnFontSizeChanged(Double, Double)

For internal use by the Xamarin.Forms platform.

INameScope.RegisterName(String, Object)

For internal use only.

(Inherited from Element)
ISpatialElement.Region

For internal use by the Xamarin.Forms platform.

(Inherited from GestureElement)

Extension Methods

GetPropertyIfSet<T>(BindableObject, BindableProperty, T)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)

Creates and applies a binding to a property.

SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)
Obsolete.

Creates and applies a binding from an expression.

SetOnAppTheme<T>(BindableObject, BindableProperty, T, T)
FindByName<T>(Element, String)

Returns the instance of type T that has name name in the scope that includes element.

Applies to