Hide

YetaWF.Core Package Documentation

Display
Print

YetaWF.Core.Modules.ModuleDefinition Class

(not specified)

(not specified)

Namespace: YetaWF.Core.Modules
Assembly: YetaWF.Core

Inheritance

Syntax

public class ModuleDefinition;

Constructors

PublicModuleDefinitionConstructor.

Properties

Public_SuppressPartialFormCss(not specified)
PublicAction(not specified)
PublicAdministratorLevel_DefaultAllowedRolesReturns the admin role as allowed role
PublicAllowedRoles(not specified)
PublicAllowedUsers(not specified)
PublicAnchorId(not specified)
PublicAnonymousLevel_DefaultAllowedRolesReturns the anonymous role and all others as allowed roles
PublicAreaName(not specified)
PublicStaticBaseFolderName(not specified)
PublicCanMinimize(not specified)
PublicCategoryOrder(not specified)
PublicClassName(not specified)
PublicCompanyDisplayName(not specified)
PublicCompanyName(not specified)
PublicConfigDataReturns configuration data if the module is a configuration module.
PublicController(not specified)
PublicCssClassThe CSS class name used on the <div> tag for this module. The allowable CSS class name is a subset of the CSS specification. Only characters _, a-z, A-Z and 0-9 are allowed, Ansi and Unicode escapes are not allowed.
PublicDateCreated(not specified)
PublicDateUpdated(not specified)
PublicDefaultAllowedRolesReturns the module's default allowed roles
PublicDefaultViewName(not specified)
PublicDescription(not specified)
PublicDomain(not specified)
PublicEditorLevel_DefaultAllowedRolesReturns the admin role as allowed role
PublicExtraRoles(not specified)
PublicFormAutoComplete(not specified)
PublicFullClassName(not specified)
PublicHelpURL(not specified)
PublicInvokable(not specified)
PublicInvokeInAjax(not specified)
PublicInvokeInPopup(not specified)
PublicInvokingCssDefines the class that causes this module to be injected at the end of the page.
PublicIsModuleUnique(not specified)
PublicMinimized(not specified)
PublicModuleDataFolder(not specified)
PublicModuleDisplayName(not specified)
PublicModuleGuid(not specified)
PublicModuleGuidNameReturns the module's unique id as a string.
PublicModuleHasSettings(not specified)
PublicModuleHtmlIdModule Id used in Html
PublicModuleName(not specified)
PublicModulePermanentUrl(not specified)
PublicModuleSecurity(not specified)
PublicModuleSkin(not specified)
PublicModuleSkin_Collection(not specified)
PublicName(not specified)
PublicPages
PublicPermanentGuid(not specified)
PublicPermanentModuleName(not specified)
PublicPopupPage(not specified)
PublicPopupPage_Collection(not specified)
PublicPrint(not specified)
PublicProduct(not specified)
PublicReferencedModules(not specified)
PublicRolesDefinitions(not specified)
PublicShowActionMenu(not specified)
PublicShowFormButtons(not specified)
PublicShowHelp(not specified)
PublicShowModuleMenu(not specified)
PublicShowTitle(not specified)
PublicShowTitleActions(not specified)
PublicSuperuserLevel_DefaultAllowedRolesReturns the superuser role as allowed role
PublicSupportedTemplatesTemplates supported by this module (needed for ajax requests so pages can include all required template support even if the actual template isn't used until an ajax request occurs)
PublicTemporary(not specified)
PublicTempPageCssClassThe CSS class name to add to a temporary page's <body> tag when this module is used on a temporary page. Temporary pages are used when a module is displayed without a permanent, designed page.
PublicTitle(not specified)
PublicUsePartialFormCssDefines whether the skin's partial form CSS is added to partial forms.
PublicUserLevel_DefaultAllowedRolesReturns the default allowed roles - user, editor and admin
PublicVersion(not specified)
PublicVisible(not specified)
PublicWantFocus(not specified)
PublicWantSearch(not specified)
ProtectedStaticHaveManager(not specified)
ProtectedStaticManager(not specified)

Fields

PublicStaticMaxCssClass(not specified)
PublicStaticMaxDescription(not specified)
PublicStaticMaxHtmlId(not specified)
PublicStaticMaxName(not specified)
PublicStaticMaxTitle(not specified)
PublicStaticModuleContentsFile(not specified)
PublicStaticModuleIDFile(not specified)

Methods

Public__GetPagesAsync(not specified)
PublicAddModuleReferenceMethod used in site templates to add a module reference to the current page.
PublicStaticCreateCreates a new module definition. This creates an instance of a module from a known assembly and module type. Applications should not create members using this method. It is reserved for internal functions.
PublicStaticCreateNewDesignedModuleCreates a new designed module. Remember to set the ModuleGuid property after creating the module.
PublicStaticCreateUniqueModuleAsyncCreate a unique module.
ProtectedCustomIconAsync(not specified)
PublicCustomSearch(not specified)
PublicCustomValidation(not specified)
PublicInherited from System.ObjectEqualsDetermines whether the specified object is equal to the current object.
PublicExportDataAsync(not specified)
ProtectedInherited from System.ObjectFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
PublicStaticFindDesignedModuleAsyncFind a designed module given a URL
ProtectedGetAllModuleActionsAsyncPopulates the module actions
PublicGetConfigDataProvider(not specified)
PublicGetDataProvider(not specified)
PublicInherited from System.ObjectGetHashCodeServes as the default hash function.
PublicGetModuleActionAsyncRetrieve a known module action with parameters.
PublicGetModuleActionsAsyncRetrieve a known module action with parameters.
PublicStaticGetModuleDataFolder(not specified)
ProtectedStaticGetModuleGuidName(not specified)
PublicGetModuleMenuListAsync(not specified)
PublicStaticGetModulePermanentUrl(not specified)
PublicStaticGetModuleUrl(not specified)
PublicStaticGetPermanentGuid(not specified)
PublicInherited from System.ObjectGetTypeGets the Type of the current instance.
PublicStaticImportAsync(not specified)
PublicIsAuthorized(not specified)
PublicIsAuthorized_View_Administrator(not specified)
PublicIsAuthorized_View_Anonymous(not specified)
PublicIsAuthorized_View_AnyUser(not specified)
PublicIsAuthorized_View_Editor(not specified)
PublicStaticLoadAsyncLoads a module's definition. This loads unique and non-unique, designed and installed modules, as long as the guid exists. Modules can always be loaded even if they haven't been saved yet, as long as the guid exists. If a perm guid is used for a non-unique module a new TEMPORARY module is created
PublicStaticLoadByUrlAsyncFind an installed module given a URL
ProtectedInherited from System.ObjectMemberwiseCloneCreates a shallow copy of the current Object.
PublicModuleRemovingAsync(not specified)
PublicModuleSavingAsync(not specified)
PublicStaticProcessModuleError(not specified)
PublicStaticInherited from System.ObjectReferenceEqualsDetermines whether the specified Object instances are the same instance.
PublicRenderModuleAsync(not specified)
PublicRenderModuleViewAsyncRender module in view mode, overriding edit mode.
PublicRenderReferencedModule_AjaxAsyncAjax invoked modules - used to render REFERENCED modules during ajax calls
PublicRetrieveModuleActionsAsync(not specified)
PublicSaveAsyncSaves a module definition. This saves unique and non-unique, designed and installed modules
PublicInherited from System.ObjectToStringReturns a string that represents the current object.
PublicTryGetConfigDataProvider(not specified)
PublicStaticTryRemoveAsyncRemoves a module definition.
PublicUpdateConfigProperty(not specified)

Enums

ProtectedAllowedEnum(not specified)

See Also YetaWF.Core Overview