Partager via

Core.CustomOperationAttribute Class (F#)

  • Article

Indicates that a member on a computation builder type is a custom query operator, and indicates the name of that operator.

Namespace/Module Path: Microsoft.FSharp.Core

Assembly: FSharp.Core (in FSharp.Core.dll)

[<AttributeUsage(AttributeTargets.Method, AllowMultiple = false)>]
[<Sealed>]
type 
CustomOperationAttribute
 =
 class
  new CustomOperationAttribute : string -> CustomOperationAttribute
  member this.AllowIntoPattern : bool with get, set
  member this.IsLikeGroupJoin : bool with get, set
  member this.IsLikeJoin : bool with get, set
  member this.IsLikeZip : bool with get, set
  member this.MaintainsVariableSpace : bool with get, set
  member this.MaintainsVariableSpaceUsingBind : bool with get, set
  member this.Name : string
  member this.IsLikeGroupJoin : bool with get, set
  member this.IsLikeJoin : bool with get, set
  member this.IsLikeZip : bool with get, set
  member this.JoinConditionWord : string with get, set
  member this.MaintainsVariableSpace : bool with get, set
  member this.MaintainsVariableSpaceUsingBind  : bool with get, set
 end

Remarks

You can also use the short form of the name, CustomOperation.

Constructors

Member

Description

new

Creates an instance of the attribute

Instance Members

Member

Description

AllowIntoPattern : bool with get, set

Indicates if the custom operation supports the use of into immediately after the use of the operation in a query or other computation expression to consume the results of the operation.

IsLikeGroupJoin : bool with get, set

Indicates if the custom operation is an operation similar to a group join in a sequence computation, in that it supports two inputs and a correlation constraint, and generates a group.

IsLikeJoin : bool with get, set

Indicates if the custom operation is an operation similar to a join in a sequence computation, in that it supports two inputs and a correlation constraint.

IsLikeZip : bool with get, set

Indicates if the custom operation is an operation similar to a zip in a sequence computation, in that it supports two inputs.

JoinConditionWord : string

Indicates the name used for the "on" part of the custom query operator for join-like operators.

MaintainsVariableSpace : bool with get, set

Indicates if the custom operation maintains the variable space of the query of computation expression.

MaintainsVariableSpaceUsingBind : bool with get, set

Indicates if the custom operation maintains the variable space of the query of computation expression through the use of a bind operation.

Name : string

The name of the custom operation when used in a query or other computation expression.

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

See Also

Reference

Microsoft.FSharp.Core Namespace (F#)