Show / Hide Table of Contents

Class TaskMenu

Configurable Menu Items are items that will be merged into menus in given area and entity

Carrier object for TaskMenu. Services for the TaskMenu Carrier is available from the List Agent.
Inheritance
object
TaskMenu
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class TaskMenu : Carrier
Examples

Get TaskMenu 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ListAgent();
   var taskMenu = agent.GetTaskMenu( 123 );
}

Constructors

TaskMenu()

Default constructor

Declaration
public TaskMenu()
See Also
IListAgent

Properties

ArchiveBehaviour

None, rightclick on, multiselect

Declaration
[DataMember]
public virtual ArchiveBehaviour ArchiveBehaviour { get; set; }
Property Value
Type Description
ArchiveBehaviour
See Also
IListAgent

Area

Can be Task or other that can identify which menu recipe to merge the item into

Declaration
[DataMember]
public virtual string Area { get; set; }
Property Value
Type Description
string
See Also
IListAgent

CrmScriptId

The CRMScript or Macro which will be run task item is selected.

Declaration
[DataMember]
public virtual int CrmScriptId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

Deleted

True if deleted

Declaration
[DataMember]
public virtual bool Deleted { get; set; }
Property Value
Type Description
bool
See Also
IListAgent

Encoding

Encoding for url

Declaration
[DataMember]
public virtual UrlEncoding Encoding { get; set; }
Property Value
Type Description
UrlEncoding
See Also
IListAgent

Name

The list item

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
IListAgent

ProgId

String key that can be used to uniquely retrieve the task menu; particularly useful for partners and others who do not wish to store database ID's

Declaration
[DataMember]
public virtual string ProgId { get; set; }
Property Value
Type Description
string
See Also
IListAgent

Rank

Rank order

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short
See Also
IListAgent

ShowInClient

Show task list item in which clients (web, mobile)

Declaration
[DataMember]
public virtual ShowTaskItemInClient ShowInClient { get; set; }
Property Value
Type Description
ShowTaskItemInClient
See Also
IListAgent

TableName

The name of entity that this task item can be used at

Declaration
[DataMember]
public virtual string TableName { get; set; }
Property Value
Type Description
string
See Also
IListAgent

TaskMenuId

Primary key

Declaration
[DataMember]
public virtual int TaskMenuId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

TaskType

Type of task item Url, SoProtocol or CRMScript.

Declaration
[DataMember]
public virtual TaskListItemType TaskType { get; set; }
Property Value
Type Description
TaskListItemType
See Also
IListAgent

Tooltip

Tooltip or other description

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string
See Also
IListAgent

UrlOrSoprotocol

The url or soprotocol

Declaration
[DataMember]
public virtual string UrlOrSoprotocol { get; set; }
Property Value
Type Description
string
See Also
IListAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IListAgent

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)

Returns
Type Description
string

The carrier contents.

See Also
IListAgent

See Also

IListAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top