BulletSpan Class

Reference

Definition

Namespace:: Android.Text.Style

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A span which styles paragraphs as bullet points (respecting layout direction).

[Android.Runtime.Register("android/text/style/BulletSpan", DoNotGenerateAcw=true)]
public class BulletSpan : Java.Lang.Object, Android.Text.IParcelableSpan, Android.Text.Style.ILeadingMarginSpan, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/text/style/BulletSpan", DoNotGenerateAcw=true)>]
type BulletSpan = class
    inherit Object
    interface IParcelableSpan
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
    interface ILeadingMarginSpan
    interface IParagraphStyle

Inheritance: Object

Object
BulletSpan

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IParcelableSpan ILeadingMarginSpan IParagraphStyle IJavaPeerable IDisposable

Remarks

A span which styles paragraphs as bullet points (respecting layout direction).

BulletSpans must be attached from the first character to the last character of a single paragraph, otherwise the bullet point will not be displayed but the first paragraph encountered will have a leading margin.

BulletSpans allow configuring the following elements: <ul> <li>gap width - the distance, in pixels, between the bullet point and the paragraph. Default value is 2px.</li> <li>color - the bullet point color. By default, the bullet point color is 0 - no color, so it uses the TextView's text color.</li> <li>bullet radius - the radius, in pixels, of the bullet point. Default value is 4px.</li> </ul> For example, a BulletSpan using the default values can be constructed like this:

{@code
             SpannableString string = new SpannableString("Text with\nBullet point");
            string.setSpan(new BulletSpan(), 10, 22, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);}

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

To construct a BulletSpan with a gap width of 40px, green bullet point and bullet radius of 20px:

{@code
             SpannableString string = new SpannableString("Text with\nBullet point");
            string.setSpan(new BulletSpan(40, color, 20), 10, 22, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);}

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

Java documentation for android.text.style.BulletSpan.

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

BulletSpan()	Creates a `BulletSpan` with the default values.
BulletSpan(Int32, Color, Int32)	Creates a `BulletSpan` based on a gap width and a color integer.
BulletSpan(Int32, Color)	Creates a `BulletSpan` based on a gap width and a color integer.
BulletSpan(Int32)	Creates a `BulletSpan` based on a gap width
BulletSpan(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.
BulletSpan(Parcel)	Creates a `BulletSpan` from a parcel.

Fields

StandardGapWidth

Properties

BulletRadius	Get the radius, in pixels, of the bullet point.
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Color	Get the bullet point color.
GapWidth	Get the distance, in pixels, between the bullet point and the paragraph.
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.
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, 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)
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)
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

Share via