Navigation :
Introduction
FAQ
Setup, deployment & projects
Getting started
Examples
Catel.Core
Catel.MVVM
Catel.Fody
Catel.ReSharper
Tips & tricks
API reference
-
Catel.Cores
--
Catel
---
Catel.Android
---
Catel.ApiCop
----
Catel.ApiCop.Listeners
----
Catel.ApiCop.Rules
---- ApiCop
---- ApiCopListenerBase
---- ApiCopListenerGrouping
---- ApiCopManager
---- ApiCopResult
---- ApiCopRule
---- ApiCopRuleLevel
---- IApiCop
---- IApiCopListener
---- IApiCopResult
---- IApiCopRule
---- TextApiCopListenerBase
---
Catel.Caching
---
Catel.Collections
---
Catel.ComponentModel
---
Catel.Configuration
---
Catel.Core
---
Catel.Data
---
Catel.ExceptionHandling
---
Catel.IO
---
Catel.IoC
---
Catel.Linq
---
Catel.Logging
---
Catel.Messaging
---
Catel.Pooling
---
Catel.Reflection
---
Catel.Runtime
---
Catel.Scoping
---
Catel.Services
---
Catel.Test
---
Catel.Text
---
Catel.Threading
--- Argument
--- AsyncEventHandler
--- AsyncEventHandlerExtensions
--- ByteArrayExtensions
--- CatelEnvironment
--- CompositeFilter
--- CompositePredicate
--- CoreModule
--- DesignTimeCodeAttribute
--- DesignTimeHelper
--- DesignTimeInitializer
--- Disposable
--- DisposableToken
--- Enum
--- EnvironmentHelper
--- EventHandlerExtensions
--- ExceptionExtensions
--- ExceptionFactory
--- ExpressionHelper
--- FastDateTime
--- HashHelper
--- IBindableEnum
--- ICommandManagerExtensions
--- ICompositeFilter
--- IDisposableToken
--- IExecute
--- IExecuteWithObject
--- IFluent
--- INotifyPropertyChangedExtensions
--- IUniqueIdentifyable
--- IWeakAction
--- IWeakEventListener
--- IWeakFunc
--- IWeakReference
--- JsonExtensions
--- KnownPlatforms
--- LanguageHelper
--- MVVMModule
--- MustBeImplementedException
--- NotSupportedInPlatformException
--- ObjectHelper
--- ObjectToStringHelper
--- OpenInstanceActionHandler
--- OpenInstanceEventHandler
--- ParallelHelper
--- Platforms
--- ProcessExtensions
--- ProgressContext
--- ResourceHelper
--- SerializationJsonModule
--- StringExtensions
--- StringToObjectHelper
--- SupportedPlatforms
--- TagHelper
--- ThemeHelper
--- ThreadHelper
--- UniqueIdentifierHelper
--- UriExtensions
--- WeakAction
--- WeakActionBase
--- WeakEventListener
--- WeakFunc
--
Systems
-
Catel.MVVMs
-
Catel.Serialization.Jsons
ApiCop
Name
Value
Assembly
Catel.Core
Namespace
Catel.ApiCop
Available on
.NET Framework 4.5, .NET Framework 4.6, Portable Class Libraries, Xamarin - Android, Xamarin - iOS
public class ApiCop : IApiCop
Implements interfaces
IApiCop
ApiCop writer class.
Fields
Constructors
ApiCop(Type targetType)
Initializes a new instance of the ApiCop class.
Parameters
Name
Description
targetType
The type for which this ApiCop is intented.
Exceptions
Name
Description
ArgumentNullException
The targetType isnull
.
Properties
TargetType
Gets the target type of the ApiCop. This is the type where the ApiCop is created for.
Methods
GetResults()
Gets the results of this specific ApiCop.
Returns
The results of this ApiCop.
RegisterRule<TRule>(TRule rule)
Registers the rule with this ApiCop.
Type Parameters
TRule
The type of the rule.
Parameters
Name
Description
rule
The rule.
Returns
The rule.
Exceptions
Name
Description
ArgumentNullException
The rule isnull
.
UpdateRule<TRule>(string name, Action<TRule> action)
Updates the rule with the specified name. If the rule is found and the ApiCop functionality is enabled, the specified action will be invoked on the registered rule.
Type Parameters
TRule
The type of the rule.
Parameters
Name
Description
name
The name.
action
The action.
Returns
The rule ornull
if the rule is not registered first.
Exceptions
Name
Description
ArgumentException
The name isnull
or whitespace.
ArgumentNullException
The action isnull
.
Have a question about Catel? Use StackOverflow with the Catel tag!
Discussion
Please enable JavaScript to view the comments powered by Disqus.