[This is preliminary documentation and is subject to change.]
The Portal type exposes the following members.Constructors
| Name | Description | |
|---|---|---|
| Portal |
Makes portal from config.
Due to the nature of Portal object there is no need to create other parametrized ctors
|
Methods
| Name | Description | |
|---|---|---|
| __setComponentDirector | (Inherited from ApplicationComponent.) | |
| AmountToString(Decimal, Portal MoneyFormat, ISession) |
Converts financial amount in portals.default currency to string per portal
| |
| AmountToString(Amount, Portal MoneyFormat, ISession) |
Converts financial amount to string per portal
| |
| CountryISOCodeToLanguageISOCode |
Converts country code into language code per this portal
| |
| DateTimeToString |
Converts datetime to string per portal
| |
| Destructor | (Overrides ApplicationComponent Destructor .) | |
| Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) | |
| DoLocalizeRecordModel |
Localizes record model schema:field:value
| |
| DoLookupLocalizationValue | ||
| EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) | |
Determines whether the specified object is equal to the current object. (Inherited from | ||
| ExternalGetParameter |
Gets external parameter value returning true if parameter was found
| |
| ExternalParametersForGroups |
Returns named parameters that can be used to control this component
| |
| ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
| |
| Finalize | (Inherited from DisposableObject.) | |
Serves as the default hash function. (Inherited from | ||
| GetLanguageISOCode |
Tries to determine session/work context lang and returns it or DefaultLanguageISOCode
| |
| GetLocalizableContent |
Override to add localizable system content blocks.
Each block has a key of the form: 'keyname_isoLang'. I.e. {"mnuStart_deu", "Anfangen"}...
| |
Gets the (Inherited from | ||
Creates a shallow copy of the current (Inherited from | ||
| ToString | (Overrides | |
| TranslateContent |
Translates the named content into desired language trying to infer language from work context/locality/session.
The search is first done in this portal then in inherited portals.
Returns an empty string if no translation is possible
|
Extension Methods
Fields
Properties
| Name | Description | |
|---|---|---|
| ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) | |
| ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) | |
| ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) | |
| ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) | |
| DefauISOCurrency |
Returns default currency ISO code for this portal
| |
| Default |
If true, matches this portal when no other suites
| |
| DefaultISOCountry |
Returns default country ISO code for this portal
| |
| DefaultLanguageISOCode |
Returns default language ISO code for this portal
| |
| DefaultTheme |
Returns the default theme used
| |
| Description |
English/primary language description
| |
| DisplayName |
Primary site display name in primary language
| |
| Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) | |
| DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) | |
| DumpLocalizationErrors |
Set to true to capture the localization errors in log - used for development
| |
| ExternalParameters |
Returns named parameters that can be used to control this component
| |
| InstrumentationEnabled |
Implements IInstrumentable
| |
| Name |
Globally-unique portal name/ID
| |
| Offline |
If true, does not get matched per request
| |
| Parent |
Returns parent portal as identified by ParentName or null.
Makes sure that there is no cycle in portal derivation
| |
| ParentName |
Points to the parent portal instance where some settings can be cloned (i.e. localization strings)
| |
| PrimaryRootUri |
Primary root URL used to access this portal
| |
| RecordModelGenerator |
Returns record model generator that creates JSON for WV.JS library form server-supplied metadata
| |
| Themes |
Themes tha this portal supports
|
See Also