Class WebPanelEntity
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for WebPanelEntity.
The web panel entity contains information on a web panel
Inheritance
object ←
Carrier ←
WebPanelEntity
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get WebPanelEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var webPanelEntity = agent.GetWebPanelEntity( 123 );
Constructors
WebPanelEntity()
Default constructor - defaults any enum props to 0.
Properties
AlwaysReloadOnShow
If set to true, the content will reload every time the panel is shown
Property Value
bool
CustomObjectEntity
The name of the custom object when VisibleIn is set to custom object
Property Value
string
Deleted
True if the web panel is marked as deleted
Property Value
bool
Icon
The icon of the webpanel
Property Value
short
Name
The name of the web panel
Property Value
string
NeverReloadOnCurrentChange
If set to true, the content will not reload on current changes, only applies to sidepanels
Property Value
bool
OnCentral
Is the webpanel visible when user is on central database
Property Value
bool
OnSalesMarketingPocket
Is the webpanel visible when user is on pocket client
Property Value
bool
OnSalesMarketingWeb
Is the webpanel visible when user is on web client
Property Value
bool
OnSatellite
Is the webpanel visible when user is on a satellite
Property Value
bool
OnTravel
Is the webpanel visible when user is on travel
Property Value
bool
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
Property Value
string
Rank
The rank of the web panel
Property Value
int
ShowInAddressBar
Does the webpanel have an address bar
Property Value
bool
Does the webpanel have a menu bar
Property Value
bool
ShowInStatusBar
Does the webpanel have a status bar
Property Value
bool
Does the webpanel have a toolbar
Property Value
bool
The tooltip of the web panel
Property Value
string
Url
The url
Property Value
string
UrlEncoding
The encoding of the URL
NULL if unknown enum value.
Property Value
UrlEncoding?
See Also
WebPanelEntity.UrlEncoding_String
UrlEncoding_String
The encoding of the URL
Raw string enum value.
Property Value
string
See Also
WebPanelEntity.UrlEncoding
VisibleIn
The webpanel is visible in
NULL if unknown enum value.
Property Value
Navigation?
See Also
WebPanelEntity.VisibleIn_String
VisibleIn_String
The webpanel is visible in
Raw string enum value.
Property Value
string
See Also
WebPanelEntity.VisibleIn
WebPanelId
The identity of the web panel
Property Value
int
WindowName
The window which the URL address is to open in (webpanel only)
Property Value
string
See Also
ListAgent
