Photon Server API Documentation v5.0RC1

Classes | Enumerations
Photon.Common.Annotations Namespace Reference

Classes

class  AspMvcActionAttribute
 ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC action. If applied to a method, the MVC action name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)
 
class  AspMvcActionSelectorAttribute
 ASP.NET MVC attribute. When applied to a parameter of an attribute, indicates that this parameter is an MVC action name
 
class  AspMvcAreaAttribute
 ASP.NET MVC attribute. Indicates that a parameter is an MVC area. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)
 
class  AspMvcAreaMasterLocationFormatAttribute
 
class  AspMvcAreaPartialViewLocationFormatAttribute
 
class  AspMvcAreaViewLocationFormatAttribute
 
class  AspMvcControllerAttribute
 ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC controller. If applied to a method, the MVC controller name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)
 
class  AspMvcDisplayTemplateAttribute
 ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)
 
class  AspMvcEditorTemplateAttribute
 ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)
 
class  AspMvcMasterAttribute
 ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute for custom wrappers similar to System.Web.Mvc.Controller.View(String, String)
 
class  AspMvcMasterLocationFormatAttribute
 
class  AspMvcModelTypeAttribute
 ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object)
 
class  AspMvcPartialViewAttribute
 ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC partial view. If applied to a method, the MVC partial view name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)
 
class  AspMvcPartialViewLocationFormatAttribute
 
class  AspMvcSupressViewErrorAttribute
 ASP.NET MVC attribute. Allows disabling all inspections for MVC views within a class or a method.
 
class  AspMvcTemplateAttribute
 ASP.NET MVC attribute. Indicates that a parameter is an MVC template. Use this attribute for custom wrappers similar to System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)
 
class  AspMvcViewAttribute
 ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view. If applied to a method, the MVC view name is calculated implicitly from the context. Use this attribute for custom wrappers similar to System.Web.Mvc.Controller.View(Object)
 
class  AspMvcViewLocationFormatAttribute
 
class  BaseTypeRequiredAttribute
 When applied to a target attribute, specifies a requirement for any type marked with the target attribute to implement or inherit specific type or types.
 
class  CanBeNullAttribute
 Indicates that the value of the marked element could be null sometimes, so the check for null is necessary before its usage More...
 
class  CannotApplyEqualityOperatorAttribute
 Indicates that the value of the marked type (or its derivatives) cannot be compared using '==' or '!=' operators and Equals() should be used instead. However, using '==' or '!=' for comparison with null is always permitted.
 
class  ContractAnnotationAttribute
 Describes dependency between method input and output
 
class  HtmlAttributeValueAttribute
 
class  HtmlElementAttributesAttribute
 
class  InstantHandleAttribute
 Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. If the parameter is a delegate, indicates that delegate is executed while the method is executed. If the parameter is an enumerable, indicates that it is enumerated while the method is executed
 
class  InvokerParameterNameAttribute
 Indicates that the function argument should be string literal and match one of the parameters of the caller function. For example, ReSharper annotates the parameter of System.ArgumentNullException
 
class  LocalizationRequiredAttribute
 Indicates that marked element should be localized or not
 
class  MeansImplicitUseAttribute
 Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes as unused (as well as by other usage inspections)
 
class  NotifyPropertyChangedInvocatorAttribute
 Indicates that the method is contained in a type that implements System.ComponentModel.INotifyPropertyChanged interface and this method is used to notify that some property value changed
 
class  NotNullAttribute
 Indicates that the value of the marked element could never be null More...
 
class  PathReferenceAttribute
 Indicates that a parameter is a path to a file or a folder within a web project. Path can be relative or absolute, starting from web root (~)
 
class  PublicAPIAttribute
 This attribute is intended to mark publicly available API which should not be removed and so is treated as used
 
class  PureAttribute
 Indicates that a method does not make any observable state changes. The same as System.Diagnostics.Contracts.PureAttribute
 
class  RazorSectionAttribute
 Razor attribute. Indicates that a parameter or a method is a Razor section. Use this attribute for custom wrappers similar to System.Web.WebPages.WebPageBase.RenderSection(String)
 
class  StringFormatMethodAttribute
 Indicates that the marked method builds string by format pattern and (optional) arguments. Parameter, which contains format string, should be given in constructor. The format string should be in string.Format(IFormatProvider,string,object[])-like form
 
class  UsedImplicitlyAttribute
 Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), so this symbol will not be marked as unused (as well as by other usage inspections)
 

Enumerations

enum  ImplicitUseKindFlags {
  ImplicitUseKindFlags.Default = Access | Assign | InstantiatedWithFixedConstructorSignature, ImplicitUseKindFlags.Access = 1, ImplicitUseKindFlags.Assign = 2, ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature = 4,
  ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature = 8
}
 
enum  ImplicitUseTargetFlags { ImplicitUseTargetFlags.Default = Itself, ImplicitUseTargetFlags.Itself = 1, ImplicitUseTargetFlags.Members = 2, ImplicitUseTargetFlags.WithMembers = Itself | Members }
 Specify what is considered used implicitly when marked with MeansImplicitUseAttribute or UsedImplicitlyAttribute More...
 

Enumeration Type Documentation

◆ ImplicitUseKindFlags

Enumerator
Default 
Access 

Only entity marked with attribute considered used

Assign 

Indicates implicit assignment to a member

InstantiatedWithFixedConstructorSignature 

Indicates implicit instantiation of a type with fixed constructor signature. That means any unused constructor parameters won't be reported as such.

InstantiatedNoFixedConstructorSignature 

Indicates implicit instantiation of a type

◆ ImplicitUseTargetFlags

Specify what is considered used implicitly when marked with MeansImplicitUseAttribute or UsedImplicitlyAttribute

Enumerator
Default 
Itself 
Members 

Members of entity marked with attribute are considered used

WithMembers 

Entity marked with attribute and all its members considered used