FormPropertyBag Class

Article
09/23/2016

Used to pass data from built-in UI to an adorner.

Namespace: Microsoft.WindowsServerSolutions.Administration.ObjectModel.Adorners
Assembly: Microsoft.WindowsServerSolutions.Administration.ObjectModel (in Microsoft.WindowsServerSolutions.Administration.ObjectModel.dll)

Inheritance Hierarchy

System.Object
System.MarshalByRefObject
Microsoft.WindowsServerSolutions.Administration.ObjectModel.Adorners.FormPropertyBag

Syntax

[SerializableAttribute]
public class FormPropertyBag : MarshalByRefObject

[SerializableAttribute]
public ref class FormPropertyBag : MarshalByRefObject

<SerializableAttribute>
Public Class FormPropertyBag
    Inherits MarshalByRefObject

Properties

	Name	Description
	AddinData	Retrieves optional add-in data from a custom add-in UI.
	FirstName	Retrieves the first name of a user from the UI.
	LastName	Retrieves the last name of the user from a UI.
	Password	Retrieves the password.
	UserName	Retrieves the user name.

Methods

	Name	Description
	CreateObjRef(Type)	(Inherited from MarshalByRefObject.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetLifetimeService()	(Inherited from MarshalByRefObject.)
	GetType()	(Inherited from Object.)
	InitializeLifetimeService()	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	ToString()	(Inherited from Object.)

Remarks

For more information on using this class, see Extending and Replacing the Email UI.

Examples

The following code describes using FormPropertyBag to pass data into an overridden CreatePage method. For the complete sample, see Quickstart: Creating a Hosted Email Adapter.

public override ICollection<AddinPageContent> CreatePages(FormPropertyBag propertyBag)
{
    List<AddinPageContent> list = new List<AddinPageContent>();
    content = new DistributionGroupTabContent(propertyBag)
    {
        Title = Resources.DGTab_Name,
        HelpLink = null,
        HelpLinkText = null
    }; 
    list.Add(content);
    return list;
}

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via