QuoteSpan Class

Definition

A span which styles paragraphs by adding a vertical stripe at the beginning of the text (respecting layout direction).

[Android.Runtime.Register("android/text/style/QuoteSpan", DoNotGenerateAcw=true)]
public class QuoteSpan : Java.Lang.Object, Android.Text.IParcelableSpan, Android.Text.Style.ILeadingMarginSpan, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/text/style/QuoteSpan", DoNotGenerateAcw=true)>]
type QuoteSpan = class
    inherit Object
    interface IParcelableSpan
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface ILeadingMarginSpan
    interface IParagraphStyle
Inheritance
QuoteSpan
Attributes
Implements

Remarks

A span which styles paragraphs by adding a vertical stripe at the beginning of the text (respecting layout direction).

A QuoteSpan must be attached from the first character to the last character of a single paragraph, otherwise the span will not be displayed.

QuoteSpans allow configuring the following elements: <ul> <li><b>color</b> - the vertical stripe color. By default, the stripe color is 0xff0000ff</li> <li><b>gap width</b> - the distance, in pixels, between the stripe and the paragraph. Default value is 2px.</li> <li><b>stripe width</b> - the width, in pixels, of the stripe. Default value is 2px.</li> </ul> For example, a QuoteSpan using the default values can be constructed like this:

{@code SpannableString string = new SpannableString("Text with quote span on a long line");
            string.setSpan(new QuoteSpan(), 0, string.length(), Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);}

<img src="https://developer.android.com/reference/android/images/text/style/defaultquotespan.png" /> <figcaption>QuoteSpan constructed with default values.</figcaption>

To construct a QuoteSpan with a green stripe, of 20px in width and a gap width of 40px:

{@code SpannableString string = new SpannableString("Text with quote span on a long line");
            string.setSpan(new QuoteSpan(Color.GREEN, 20, 40), 0, string.length(),
            Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);}

<img src="https://developer.android.com/reference/android/images/text/style/customquotespan.png" /> <figcaption>Customized QuoteSpan.</figcaption>

Java documentation for android.text.style.QuoteSpan.

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

QuoteSpan()

Creates a QuoteSpan with the default values.

QuoteSpan(Color)

Creates a QuoteSpan based on a color.

QuoteSpan(Color, Int32, Int32)

Creates a QuoteSpan based on a color, a stripe width and the width of the gap between the stripe and the text.

QuoteSpan(IntPtr, JniHandleOwnership)

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

QuoteSpan(Parcel)

Create a QuoteSpan from a parcel.

Fields

StandardColor

Default color for the quote stripe.

StandardGapWidthPx

Default gap width in pixels.

StandardStripeWidthPx

Default stripe width in pixels.

Properties

Class

Returns the runtime class of this Object.

(Inherited from Object)
Color

Get the color of the quote stripe.

GapWidth

Get the width of the gap between the stripe and the text.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
PeerReference (Inherited from Object)
SpanTypeId

Return a special type identifier for this span class.

StripeWidth

Get the width of the quote stripe.

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.

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
DescribeContents()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
DrawLeadingMargin(Canvas, Paint, Int32, Int32, Int32, Int32, Int32, ICharSequence, Int32, Int32, Boolean, Layout)

Renders the leading margin.

DrawLeadingMargin(Canvas, Paint, Int32, Int32, Int32, Int32, Int32, String, Int32, Int32, Boolean, Layout)
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)
GetLeadingMargin(Boolean)

Returns the amount by which to adjust the leading margin.

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)
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)
WriteToParcel(Parcel, ParcelableWriteFlags)

Flatten this object in to a Parcel.

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.

DrawLeadingMargin(ILeadingMarginSpan, Canvas, Paint, Int32, Int32, Int32, Int32, Int32, String, Int32, Int32, Boolean, Layout)
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to