ActionProvider Class

Definition

Namespace:: Android.Views

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.

An ActionProvider defines rich menu interaction in a single component.

[Android.Runtime.Register("android/view/ActionProvider", DoNotGenerateAcw=true)]
public abstract class ActionProvider : Java.Lang.Object

[<Android.Runtime.Register("android/view/ActionProvider", DoNotGenerateAcw=true)>]
type ActionProvider = class
    inherit Object

Inheritance: Object

JavaObject

Object
ActionProvider

Derived: Android.App.MediaRouteActionProvider

Android.Widget.ShareActionProvider

Attributes: RegisterAttribute

Remarks

An ActionProvider defines rich menu interaction in a single component. ActionProvider can generate action views for use in the action bar, dynamically populate submenus of a MenuItem, and handle default menu item invocations.

An ActionProvider can be optionally specified for a MenuItem and will be responsible for creating the action view that appears in the android.app.ActionBar in place of a simple button in the bar. When the menu item is presented in a way that does not allow custom action views, (e.g. in an overflow menu,) the ActionProvider can perform a default action.

There are two ways to use an action provider: <ul> <li> Set the action provider on a MenuItem directly by calling MenuItem#setActionProvider(ActionProvider). </li> <li> Declare the action provider in an XML menu resource. For example:

<code>
              &lt;item android:id="@+id/my_menu_item"
                android:title="Title"
                android:icon="@drawable/my_menu_item_icon"
                android:showAsAction="ifRoom"
                android:actionProviderClass="foo.bar.SomeActionProvider" /&gt;
</code>

</li> </ul> </p>

Java documentation for android.view.ActionProvider.

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

Name	Description
ActionProvider(Context)	Creates a new instance.
ActionProvider(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Name	Description
Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
HasSubMenu	Determines if this ActionProvider has a submenu associated with it.
IsVisible	If `#overridesItemVisibility()` returns true, the return value of this method will help determine the visibility of the `MenuItem` this ActionProvider is bound to.
JniIdentityHashCode	Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object)
JniManagedPeerState	(Inherited from JavaObject)
JniPeerMembers	Gets the JNI peer metadata used by the .NET for Android binding runtime.
PeerReference	Gets the JNI object reference for this Java peer. (Inherited from Object)
ThresholdClass	Gets the JNI class handle used by the .NET for Android binding runtime.
ThresholdType	Gets the managed type used by the .NET for Android binding runtime.

Methods

Name	Description
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
Dispose()	Releases the resources held by this Java peer. (Inherited from Object)
Dispose(Boolean)	Releases the resources held by this Java peer. (Inherited from Object)
DisposeUnlessReferenced()	(Inherited from JavaObject)
Equals(Object)	(Inherited from JavaObject)
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)
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)
OnCreateActionView()	Obsolete. Factory method called by the Android framework to create new action views.
OnCreateActionView(IMenuItem)	Factory method called by the Android framework to create new action views.
OnPerformDefaultAction()	Performs an optional default action.
OnPrepareSubMenu(ISubMenu)	Called to prepare an associated submenu for the menu item backed by this ActionProvider.
OverridesItemVisibility()	The result of this method determines whether or not `#isVisible()` will be used by the `MenuItem` this ActionProvider is bound to help determine its visibility.
RefreshVisibility()	If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on `#overridesItemVisibility()` and `#isVisible()`.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)	(Inherited from JavaObject)
SetVisibilityListener(ActionProvider+IVisibilityListener)	Set a listener to be notified when this ActionProvider's overridden visibility changes.
ToArray<T>()	Creates a managed array from this Java array wrapper. (Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	Unregisters this Java peer from the interop runtime. (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)

Events

Name	Description
Visibility	Occurs when the action provider visibility changes.

Explicit Interface Implementations

Name	Description
IJavaPeerable.Disposed()	(Inherited from JavaObject)
IJavaPeerable.Finalized()	(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock	(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from JavaObject)

Extension Methods

Name	Description
GetJniTypeName(IJavaPeerable)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to