Class PortalFilter
  
  Manages injection of portal into the work context
 
  
  
    Inheritance
    System.Object
    
    
    
    PortalFilter
   
  
    Implements
    
    System.IDisposable
    
    
   
  
    Inherited Members
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      System.Object.Equals(System.Object)
    
    
      System.Object.Equals(System.Object, System.Object)
    
    
      System.Object.GetHashCode()
    
    
      System.Object.GetType()
    
    
      System.Object.MemberwiseClone()
    
    
      System.Object.ReferenceEquals(System.Object, System.Object)
    
   
  
  Assembly: NFX.Wave.dll
  Syntax
  
    public class PortalFilter : WorkFilter, IApplicationComponent, IDisposable, INamed, IOrdered
   
  Constructors
  
  
  
  
  PortalFilter(WorkDispatcher, IConfigSectionNode)
  
  
  Declaration
  
    public PortalFilter(WorkDispatcher dispatcher, IConfigSectionNode confNode)
   
  Parameters
  
  
  
  
  PortalFilter(WorkDispatcher, String, Int32)
  
  
  Declaration
  
    public PortalFilter(WorkDispatcher dispatcher, string name, int order)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | WorkDispatcher | 
        dispatcher | 
         | 
      
      
        | System.String | 
        name | 
         | 
      
      
        | System.Int32 | 
        order | 
         | 
      
    
  
  
  
  
  PortalFilter(WorkHandler, IConfigSectionNode)
  
  
  Declaration
  
    public PortalFilter(WorkHandler handler, IConfigSectionNode confNode)
   
  Parameters
  
  
  
  
  PortalFilter(WorkHandler, String, Int32)
  
  
  Declaration
  
    public PortalFilter(WorkHandler handler, string name, int order)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | WorkHandler | 
        handler | 
         | 
      
      
        | System.String | 
        name | 
         | 
      
      
        | System.Int32 | 
        order | 
         | 
      
    
  
  Fields
  
  
  
  CONF_THEME_COOKIE_NAME_ATTR
  
  
  Declaration
  
    public const string CONF_THEME_COOKIE_NAME_ATTR = "theme-cookie-name"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  CONF_USE_THEME_COOKIE_ATTR
  
  
  Declaration
  
    public const string CONF_USE_THEME_COOKIE_ATTR = "use-theme-cookie"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  DEFAULT_THEME_COOKIE_NAME
  
  
  Declaration
  
    public const string DEFAULT_THEME_COOKIE_NAME = "UIT"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  VAR_PORTAL_NAME
  
  
  Declaration
  
    public const string VAR_PORTAL_NAME = "portal-name"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  Properties
  
  
  
  
  PortalMatches
  OrderedRegistry of matches used by the filter to determine whether work should match a portal
 
  
  Declaration
  
    public OrderedRegistry<WorkMatch> PortalMatches { get; }
   
  Property Value
  
  
  
  
  ThemeCookieName
  Specifies theme cookie name
 
  
  Declaration
  
    public string ThemeCookieName { get; set; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  UseThemeCookie
  Specifies true to interpret ThemeCookieName
 
  
  Declaration
  
    public bool UseThemeCookie { get; set; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  Methods
  
  
  
  
  DoFilterWork(WorkContext, IList<WorkFilter>, Int32)
  
  
  Declaration
  
    protected override sealed void DoFilterWork(WorkContext work, IList<WorkFilter> filters, int thisFilterIndex)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | WorkContext | 
        work | 
         | 
      
      
        | System.Collections.Generic.IList<WorkFilter> | 
        filters | 
         | 
      
      
        | System.Int32 | 
        thisFilterIndex | 
         | 
      
    
  
  Overrides
  
  Implements
  
  
      System.IDisposable
  
  
  
  Extension Methods