ShareActionProvider Class

Reference

Definition

Namespace:: Android.Widget

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.

This is a provider for a share action.

[Android.Runtime.Register("android/widget/ShareActionProvider", DoNotGenerateAcw=true)]
public class ShareActionProvider : Android.Views.ActionProvider

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

Inheritance: Object

Object

ActionProvider
ShareActionProvider

Attributes: RegisterAttribute

Remarks

This is a provider for a share action. It is responsible for creating views that enable data sharing and also to show a sub menu with sharing activities if the hosting item is placed on the overflow menu.

Here is how to use the action provider with custom backing file in a MenuItem:

// In Activity#onCreateOptionsMenu
            public boolean onCreateOptionsMenu(Menu menu) {
                // Get the menu item.
                MenuItem menuItem = menu.findItem(R.id.my_menu_item);
                // Get the provider and hold onto it to set/change the share intent.
                mShareActionProvider = (ShareActionProvider) menuItem.getActionProvider();
                // Set history different from the default before getting the action
                // view since a call to {@link MenuItem#getActionView() MenuItem.getActionView()} calls
                // {@link ActionProvider#onCreateActionView()} which uses the backing file name. Omit this
                // line if using the default share history file is desired.
                mShareActionProvider.setShareHistoryFileName("custom_share_history.xml");
                . . .
            }

            // Somewhere in the application.
            public void doShare(Intent shareIntent) {
                // When you want to share set the share intent.
                mShareActionProvider.setShareIntent(shareIntent);
            }

<strong>Note:</strong> While the sample snippet demonstrates how to use this provider in the context of a menu item, the use of the provider is not limited to menu items.

Java documentation for android.widget.ShareActionProvider.

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

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

Fields

DefaultShareHistoryFileName

The default name for storing share history.

Properties

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. (Inherited from ActionProvider)
IsVisible	If `#overridesItemVisibility()` returns true, the return value of this method will help determine the visibility of the `MenuItem` this ActionProvider is bound to. (Inherited from ActionProvider)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
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)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
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. To be added
OnCreateActionView(IMenuItem)	Factory method called by the Android framework to create new action views. (Inherited from ActionProvider)
OnPerformDefaultAction()	Performs an optional default action. (Inherited from ActionProvider)
OnPrepareSubMenu(ISubMenu)	Called to prepare an associated submenu for the menu item backed by this ActionProvider. (Inherited from 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. (Inherited from ActionProvider)
RefreshVisibility()	If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on `#overridesItemVisibility()` and `#isVisible()`. (Inherited from ActionProvider)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetOnShareTargetSelectedListener(ShareActionProvider+IOnShareTargetSelectedListener)	Sets a listener to be notified when a share target has been selected.
SetShareHistoryFileName(String)	Sets the file name of a file for persisting the share history which history will be used for ordering share targets.
SetShareIntent(Intent)	Sets an intent with information about the share action.
SetVisibilityListener(ActionProvider+IVisibilityListener)	Set a listener to be notified when this ActionProvider's overridden visibility changes. (Inherited from ActionProvider)
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)

Events

ShareTargetSelected
Visibility	(Inherited from ActionProvider)

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