ImageSpan Class

  • Reference

Definition

Namespace:
Android.Text.Style
Assembly:
Mono.Android.dll

Span that replaces the text it's attached to with a Drawable that can be aligned with the bottom or with the baseline of the surrounding text.

[Android.Runtime.Register("android/text/style/ImageSpan", DoNotGenerateAcw=true)]
public class ImageSpan : Android.Text.Style.DynamicDrawableSpan
[<Android.Runtime.Register("android/text/style/ImageSpan", DoNotGenerateAcw=true)>]
type ImageSpan = class
    inherit DynamicDrawableSpan
Inheritance
Object
Object
CharacterStyle
MetricAffectingSpan
ReplacementSpan
DynamicDrawableSpan
ImageSpan
Attributes
RegisterAttribute

Remarks

Span that replaces the text it's attached to with a Drawable that can be aligned with the bottom or with the baseline of the surrounding text. The drawable can be constructed from varied sources: <ul> <li>Bitmap - see #ImageSpan(Context, Bitmap) and #ImageSpan(Context, Bitmap, int)</li> <li>Drawable - see #ImageSpan(Drawable, int)</li> <li>resource id - see #ImageSpan(Context, int, int)</li> <li>Uri - see #ImageSpan(Context, Uri, int)</li> </ul> The default value for the vertical alignment is DynamicDrawableSpan#ALIGN_BOTTOM

For example, an ImagedSpan can be used like this:

SpannableString string = new SpannableString("Bottom: span.\nBaseline: span.");
            // using the default alignment: ALIGN_BOTTOM
            string.setSpan(new ImageSpan(this, R.mipmap.ic_launcher), 7, 8, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
            string.setSpan(new ImageSpan(this, R.mipmap.ic_launcher, DynamicDrawableSpan.ALIGN_BASELINE),
            22, 23, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);

<img src="https://developer.android.com/reference/android/images/text/style/imagespan.png" /> <figcaption>Text with ImageSpans aligned bottom and baseline.</figcaption>

Java documentation for android.text.style.ImageSpan.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

ImageSpan(Bitmap)
Obsolete.

This member is deprecated.
ImageSpan(Bitmap, SpanAlign)
Obsolete.

This member is deprecated.
ImageSpan(Context, Bitmap)

Constructs an ImageSpan from a Context and a Bitmap with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM
ImageSpan(Context, Bitmap, SpanAlign)

Constructs an ImageSpan from a Context, a Bitmap and a vertical alignment.
ImageSpan(Context, Int32)

Constructs an ImageSpan from a Context and a resource id with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM
ImageSpan(Context, Int32, SpanAlign)

Constructs an ImageSpan from a Context, a resource id and a vertical alignment.
ImageSpan(Context, Uri)

Constructs an ImageSpan from a Context and a Uri with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM.
ImageSpan(Context, Uri, SpanAlign)

Constructs an ImageSpan from a Context, a Uri and a vertical alignment.
ImageSpan(Drawable)

Constructs an ImageSpan from a drawable with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM.
ImageSpan(Drawable, SpanAlign)

Constructs an ImageSpan from a drawable and a vertical alignment.
ImageSpan(Drawable, String)

Constructs an ImageSpan from a drawable and a source with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM
ImageSpan(Drawable, String, SpanAlign)

Constructs an ImageSpan from a drawable, a source and a vertical alignment.
ImageSpan(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Class

Returns the runtime class of this Object.

(Inherited from Object)
ContentDescription (Inherited from ReplacementSpan)
ContentDescriptionFormatted

Gets a brief description of this ReplacementSpan for use in accessibility support. -or- Sets the specific content description into ReplacementSpan.

(Inherited from ReplacementSpan)
Drawable

Your subclass must implement this method to provide the bitmap
to be drawn.
Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
MVerticalAlignment (Inherited from DynamicDrawableSpan)
PeerReference (Inherited from Object)
Source

Returns the source string that was saved during construction.
ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
Underlying

Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by #wrap, returns the underlying CharacterStyle.

(Inherited from CharacterStyle)
VerticalAlignment

Returns the vertical alignment of this span, one of #ALIGN_BOTTOM, #ALIGN_BASELINE or #ALIGN_CENTER.

(Inherited from DynamicDrawableSpan)

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Draw(Canvas, ICharSequence, Int32, Int32, Single, Int32, Int32, Int32, Paint) (Inherited from DynamicDrawableSpan)
Draw(Canvas, String, Int32, Int32, Single, Int32, Int32, Int32, Paint)

Draws the span into the canvas.

(Inherited from ReplacementSpan)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
GetSize(Paint, ICharSequence, Int32, Int32, Paint+FontMetricsInt) (Inherited from DynamicDrawableSpan)
GetSize(Paint, String, Int32, Int32, Paint+FontMetricsInt)

Returns the width of the span.

(Inherited from ReplacementSpan)
JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
UpdateDrawState(TextPaint)

This method does nothing, since ReplacementSpans are drawn explicitly instead of affecting Paint properties.

(Inherited from ReplacementSpan)
UpdateMeasureState(TextPaint)

This method does nothing, since ReplacementSpans are measured explicitly instead of affecting Paint properties.

(Inherited from ReplacementSpan)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to