Class WebPanelEntity

The web panel entity contains information on a web panel

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

Get WebPanelEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

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

Constructors

WebPanelEntity()

Default constructor

Declaration
public WebPanelEntity()
See Also

Properties

AlwaysReloadOnShow

If set to true, the content will reload every time the panel is shown

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

Deleted

True if the web panel is marked as deleted

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

Icon

The icon of the webpanel

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

Name

The name of the web panel

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

NeverReloadOnCurrentChange

If set to true, the content will not reload on current changes, only applies to sidepanels

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

OnCentral

Is the webpanel visible when user is on central database

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

OnSalesMarketingPocket

Is the webpanel visible when user is on pocket client

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

OnSalesMarketingWeb

Is the webpanel visible when user is on web client

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

OnSatellite

Is the webpanel visible when user is on a satellite

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

OnTravel

Is the webpanel visible when user is on travel

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

ProgId

String key that can be used to uniquely retrieve the panel; 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

Rank

The rank of the web panel

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

ShowInAddressBar

Does the webpanel have an address bar

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

ShowInMenuBar

Does the webpanel have a menu bar

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

ShowInStatusBar

Does the webpanel have a status bar

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

ShowInToolBar

Does the webpanel have a toolbar

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

Tooltip

The tooltip of the web panel

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

Url

The url

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

UrlEncoding

The encoding of the URL

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

VisibleIn

The webpanel is visible in

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

WebPanelId

The identity of the web panel

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

WindowName

The window which the URL address is to open in (webpanel only)

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

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

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

See Also