Portal MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The Portal type exposes the following members.
Constructors

  NameDescription
Protected methodPortal
Makes portal from config. Due to the nature of Portal object there is no need to create other parametrized ctors
Back to Top
Methods

  NameDescription
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Public methodAmountToString(Decimal, Portal MoneyFormat, ISession)
Converts financial amount in portals.default currency to string per portal
Public methodAmountToString(Amount, Portal MoneyFormat, ISession)
Converts financial amount to string per portal
Public methodCountryISOCodeToLanguageISOCode
Converts country code into language code per this portal
Public methodDateTimeToString
Converts datetime to string per portal
Protected methodDestructor (Overrides ApplicationComponent Destructor .)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoLocalizeRecordModel
Localizes record model schema:field:value
Protected methodDoLookupLocalizationValue
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
Public methodExternalParametersForGroups
Returns named parameters that can be used to control this component
Public methodExternalSetParameter
Sets external parameter value returning true if parameter was found and set
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodGetLanguageISOCode
Tries to determine session/work context lang and returns it or DefaultLanguageISOCode
Protected methodGetLocalizableContent
Override to add localizable system content blocks. Each block has a key of the form: 'keyname_isoLang'. I.e. {"mnuStart_deu", "Anfangen"}...
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodToString (Overrides OnlineObject ToString .)
Public methodTranslateContent
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
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberCONFIG_CONTENT_SECTION
Public fieldStatic memberCONFIG_DEFAULT_ATTR
Public fieldStatic memberCONFIG_DESCR_ATTR
Public fieldStatic memberCONFIG_DISPLAY_NAME_ATTR
Public fieldStatic memberCONFIG_LOCALIZATION_SECTION
Public fieldStatic memberCONFIG_MSG_FILE_ATTR
Public fieldStatic memberCONFIG_OFFLINE_ATTR
Public fieldStatic memberCONFIG_PARENT_NAME_ATTR
Public fieldStatic memberCONFIG_PRIMARY_ROOT_URI_ATTR
Public fieldStatic memberCONFIG_RECORD_MODEL_SECTION
Public fieldStatic memberCONFIG_THEME_SECTION
Public fieldStatic memberLOC_ANY_FIELD_KEY
Public fieldStatic memberLOC_ANY_SCHEMA_KEY
Back to Top
Properties

  NameDescription
Public propertyComponentCommonName
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.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Public propertyDefauISOCurrency
Returns default currency ISO code for this portal
Public propertyDefault
If true, matches this portal when no other suites
Public propertyDefaultISOCountry
Returns default country ISO code for this portal
Public propertyDefaultLanguageISOCode
Returns default language ISO code for this portal
Public propertyDefaultTheme
Returns the default theme used
Public propertyDescription
English/primary language description
Public propertyDisplayName
Primary site display name in primary language
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyDumpLocalizationErrors
Set to true to capture the localization errors in log - used for development
Public propertyExternalParameters
Returns named parameters that can be used to control this component
Public propertyInstrumentationEnabled
Implements IInstrumentable
Public propertyName
Globally-unique portal name/ID
Public propertyOffline
If true, does not get matched per request
Public propertyParent
Returns parent portal as identified by ParentName or null. Makes sure that there is no cycle in portal derivation
Public propertyParentName
Points to the parent portal instance where some settings can be cloned (i.e. localization strings)
Public propertyPrimaryRootUri
Primary root URL used to access this portal
Public propertyRecordModelGenerator
Returns record model generator that creates JSON for WV.JS library form server-supplied metadata
Public propertyThemes
Themes tha this portal supports
Back to Top
See Also