Space Engineers
Properties | List of all members
ProtoBuf.ProtoContractAttribute Class Reference

Indicates that a type is defined for protocol-buffer serialization. More...

Inheritance diagram for ProtoBuf.ProtoContractAttribute:

Properties

string Name [get, set]
 Gets or sets the defined name of the type. More...
 
int ImplicitFirstTag [get, set]
 Gets or sets the fist offset to use with implicit field tags; only uesd if ImplicitFields is set. More...
 
bool UseProtoMembersOnly [get, set]
 If specified, alternative contract markers (such as markers for XmlSerailizer or DataContractSerializer) are ignored. More...
 
bool IgnoreListHandling [get, set]
 If specified, do NOT treat this type as a list, even if it looks like one. More...
 
ImplicitFields ImplicitFields [get, set]
 Gets or sets the mechanism used to automatically infer field tags for members. This option should be used in advanced scenarios only. Please review the important notes against the ImplicitFields enumeration. More...
 
bool InferTagFromName [get, set]
 Enables/disables automatic tag generation based on the existing name / order of the defined members. This option is not used for members marked with ProtoMemberAttribute, as intended to provide compatibility with WCF serialization. WARNING: when adding new fields you must take care to increase the Order for new elements, otherwise data corruption may occur. More...
 
int DataMemberOffset [get, set]
 Specifies an offset to apply to [DataMember(Order=...)] markers; this is useful when working with mex-generated classes that have a different origin (usually 1 vs 0) than the original data-contract. More...
 
bool SkipConstructor [get, set]
 If true, the constructor for the type is bypassed during deserialization, meaning any field initializers or other initialization code is skipped. More...
 
bool AsReferenceDefault [get, set]
 Should this type be treated as a reference by default? Please also see the implications of this, as recorded on ProtoMemberAttribute.AsReference More...
 

Detailed Description

Indicates that a type is defined for protocol-buffer serialization.

Definition at line 15 of file ProtoContractAttribute.cs.

Property Documentation

bool ProtoBuf.ProtoContractAttribute.AsReferenceDefault
getset

Should this type be treated as a reference by default? Please also see the implications of this, as recorded on ProtoMemberAttribute.AsReference

Definition at line 123 of file ProtoContractAttribute.cs.

int ProtoBuf.ProtoContractAttribute.DataMemberOffset
getset

Specifies an offset to apply to [DataMember(Order=...)] markers; this is useful when working with mex-generated classes that have a different origin (usually 1 vs 0) than the original data-contract.

This value is added to the Order of each member.

Definition at line 102 of file ProtoContractAttribute.cs.

bool ProtoBuf.ProtoContractAttribute.IgnoreListHandling
getset

If specified, do NOT treat this type as a list, even if it looks like one.

Definition at line 51 of file ProtoContractAttribute.cs.

ImplicitFields ProtoBuf.ProtoContractAttribute.ImplicitFields
getset

Gets or sets the mechanism used to automatically infer field tags for members. This option should be used in advanced scenarios only. Please review the important notes against the ImplicitFields enumeration.

Definition at line 62 of file ProtoContractAttribute.cs.

int ProtoBuf.ProtoContractAttribute.ImplicitFirstTag
getset

Gets or sets the fist offset to use with implicit field tags; only uesd if ImplicitFields is set.

Definition at line 28 of file ProtoContractAttribute.cs.

bool ProtoBuf.ProtoContractAttribute.InferTagFromName
getset

Enables/disables automatic tag generation based on the existing name / order of the defined members. This option is not used for members marked with ProtoMemberAttribute, as intended to provide compatibility with WCF serialization. WARNING: when adding new fields you must take care to increase the Order for new elements, otherwise data corruption may occur.

If not explicitly specified, the default is assumed from Serializer.GlobalOptions.InferTagFromName.

Definition at line 76 of file ProtoContractAttribute.cs.

string ProtoBuf.ProtoContractAttribute.Name
getset

Gets or sets the defined name of the type.

Definition at line 20 of file ProtoContractAttribute.cs.

bool ProtoBuf.ProtoContractAttribute.SkipConstructor
getset

If true, the constructor for the type is bypassed during deserialization, meaning any field initializers or other initialization code is skipped.

Definition at line 113 of file ProtoContractAttribute.cs.

bool ProtoBuf.ProtoContractAttribute.UseProtoMembersOnly
getset

If specified, alternative contract markers (such as markers for XmlSerailizer or DataContractSerializer) are ignored.

Definition at line 42 of file ProtoContractAttribute.cs.


The documentation for this class was generated from the following file: