FilesExpand file tree

 master

/

ScriptMemberAttribute.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

114 lines (103 loc) · 4.78 KB

 master

/

ScriptMemberAttribute.cs

Copy path

Top

File metadata and controls

• Code
• Blame

114 lines (103 loc) · 4.78 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

// Copyright (c) Microsoft Corporation. All rights reserved.

// Licensed under the MIT license.

using System;

namespace Microsoft.ClearScript

{

/// <summary>

/// Specifies how the target type member is to be exposed to script code. This extended version

/// supports additional options.

/// </summary>

/// <remarks>

/// This attribute is applicable to events, fields, methods, and properties.

/// </remarks>

[AttributeUsage(AttributeTargets.Event | AttributeTargets.Field | AttributeTargets.Method | AttributeTargets.Property)]

public sealed class ScriptMemberAttribute : ScriptUsageAttribute

{

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance.

/// </summary>

public ScriptMemberAttribute()

{

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified name.

/// </summary>

/// <param name="name">The name that script code will use to access the target type member.</param>

public ScriptMemberAttribute(string name)

{

Name = name;

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified script access setting.

/// </summary>

/// <param name="access">The script access setting for the target type member.</param>

public ScriptMemberAttribute(ScriptAccess access)

: base(access)

{

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified name and script access setting.

/// </summary>

/// <param name="name">The name that script code will use to access the target type member.</param>

/// <param name="access">The script access setting for the target type member.</param>

public ScriptMemberAttribute(string name, ScriptAccess access)

: base(access)

{

Name = name;

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified script options.

/// </summary>

/// <param name="flags">The script options for the target type member.</param>

public ScriptMemberAttribute(ScriptMemberFlags flags)

{

Flags = flags;

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified name and script options.

/// </summary>

/// <param name="name">The name that script code will use to access the target type member.</param>

/// <param name="flags">The script options for the target type member.</param>

public ScriptMemberAttribute(string name, ScriptMemberFlags flags)

{

Name = name;

Flags = flags;

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified script access setting and script options.

/// </summary>

/// <param name="access">The script access setting for the target type member.</param>

/// <param name="flags">The script options for the target type member.</param>

public ScriptMemberAttribute(ScriptAccess access, ScriptMemberFlags flags)

: base(access)

{

Flags = flags;

}

/// <summary>

/// Initializes a new <c><see cref="ScriptMemberAttribute"/></c> instance with the specified name, script access setting, and script options.

/// </summary>

/// <param name="name">The name that script code will use to access the target type member.</param>

/// <param name="access">The script access setting for the target type member.</param>

/// <param name="flags">The script options for the target type member.</param>

public ScriptMemberAttribute(string name, ScriptAccess access, ScriptMemberFlags flags)

: base(access)

{

Name = name;

Flags = flags;

}

/// <summary>

/// Gets or sets the name that script code will use to access the target type member.

/// </summary>

/// <remarks>

/// The default value is the name of the target type member. Note that this property has no

/// effect on the method binding algorithm. If a script-based call is bound to a method

/// that is exposed under a different name, it will be rejected even if an overload exists

/// that could receive the call.

/// </remarks>

public string Name { get; set; }

/// <summary>

/// Gets or sets the script options for the target type member.

/// </summary>

public ScriptMemberFlags Flags { get; set; }

}

}