NSKeyedArchiver NSKeyedArchiver Class

Definition

A concrete implementation of NSCoder that serializes to files.

[Foundation.Register("NSKeyedArchiver", true)]
public class NSKeyedArchiver : Foundation.NSCoder
type NSKeyedArchiver = class
    inherit NSCoder
Inheritance
NSKeyedArchiverNSKeyedArchiver
Attributes

Constructors

NSKeyedArchiver() NSKeyedArchiver()

Default constructor, initializes a new instance of this class.

NSKeyedArchiver(Boolean) NSKeyedArchiver(Boolean)
NSKeyedArchiver(IntPtr) NSKeyedArchiver(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSKeyedArchiver(NSMutableData) NSKeyedArchiver(NSMutableData)
NSKeyedArchiver(NSObjectFlag) NSKeyedArchiver(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AllowedClasses AllowedClasses

The current set of coded classes that allow secure coding.

(Inherited from NSCoder)
Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DecodingFailurePolicy DecodingFailurePolicy Inherited from NSCoder
Delegate Delegate

An instance of the Foundation.INSKeyedArchiverDelegate model class which acts as the class delegate.

Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
EncodedData EncodedData
Error Error Inherited from NSCoder
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
PropertyListFormat PropertyListFormat
RequiresSecureCoding RequiresSecureCoding
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
RootObjectKey RootObjectKey

Represents the value associated with the constant NSKeyedArchiveRootObjectKey

Self Self Inherited from NSObject
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
SystemVersion SystemVersion Inherited from NSCoder
WeakDelegate WeakDelegate

An object that can respond to the delegate protocol for this type

WillEncode WillEncode

Delegate invoked by the object to get a value.

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
ArchivedDataWithRootObject(NSObject) ArchivedDataWithRootObject(NSObject)
ArchivedDataWithRootObject(NSObject, Boolean, NSError) ArchivedDataWithRootObject(NSObject, Boolean, NSError)
ArchiveRootObjectToFile(NSObject, String) ArchiveRootObjectToFile(NSObject, String)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
ContainsKey(String) ContainsKey(String)

Determines whether an encoded value is available for the specified key.

(Inherited from NSCoder)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DecodeBool(String) DecodeBool(String)

Decodes the value at the specified key as a bool.

(Inherited from NSCoder)
DecodeBytes() DecodeBytes()

Decodes the next item as an array of bytes.

(Inherited from NSCoder)
DecodeBytes(nuint) DecodeBytes(nuint)

Low-level: decodes the next item into a memory block, and returns a pointer to it.

(Inherited from NSCoder)
DecodeBytes(String) DecodeBytes(String)

Decodes the requested key as an array of bytes.

(Inherited from NSCoder)
DecodeBytes(String, nuint) DecodeBytes(String, nuint)

Low-level: decodes the item with the associated key into a memory block, and returns a pointer to it.

(Inherited from NSCoder)
DecodeDouble(String) DecodeDouble(String)

Decodes the value at the specified key as a double.

(Inherited from NSCoder)
DecodeFloat(String) DecodeFloat(String)

Decodes the value at the specified key as a float.

(Inherited from NSCoder)
DecodeInt(String) DecodeInt(String)

Decodes the value at the specified key as an int.

(Inherited from NSCoder)
DecodeLong(String) DecodeLong(String)

Decodes the value at the specified key as a long.

(Inherited from NSCoder)
DecodeNInt(String) DecodeNInt(String) Inherited from NSCoder
DecodeObject() DecodeObject()

Decodes an object that has been encoded with any of the Encode* methods.

(Inherited from NSCoder)
DecodeObject(String) DecodeObject(String) Inherited from NSCoder
DecodeTopLevelObject(Class, String, NSError) DecodeTopLevelObject(Class, String, NSError) Inherited from NSCoder
DecodeTopLevelObject(NSError) DecodeTopLevelObject(NSError) Inherited from NSCoder
DecodeTopLevelObject(NSSet<Class>, String, NSError) DecodeTopLevelObject(NSSet<Class>, String, NSError) Inherited from NSCoder
DecodeTopLevelObject(String, NSError) DecodeTopLevelObject(String, NSError) Inherited from NSCoder
DecodeTopLevelObject(Type, String, NSError) DecodeTopLevelObject(Type, String, NSError) Inherited from NSCoder
DecodeTopLevelObject(Type[], String, NSError) DecodeTopLevelObject(Type[], String, NSError) Inherited from NSCoder
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSKeyedArchiver object.

DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Encode(Boolean, String) Encode(Boolean, String)

Encodes the value using the associated key.

(Inherited from NSCoder)
Encode(Byte[], Int32, Int32, String) Encode(Byte[], Int32, Int32, String)

Encodes a segment of the buffer using the specified associated key.

(Inherited from NSCoder)
Encode(Byte[], String) Encode(Byte[], String)

Encodes the byte array using the specified associated key.

(Inherited from NSCoder)
Encode(Double, String) Encode(Double, String)

Encodes the double value using the specified associated key.

(Inherited from NSCoder)
Encode(Int32, String) Encode(Int32, String)

Encodes the integer value using the specified associated key.

(Inherited from NSCoder)
Encode(Int64, String) Encode(Int64, String)

Encodes the long value using the specified associated key.

(Inherited from NSCoder)
Encode(nint, String) Encode(nint, String)

Encodes the platform-specific native integer (32 or 64 bits) using the specified associated key.

(Inherited from NSCoder)
Encode(NSObject) Encode(NSObject)

Encodes the specified object.

(Inherited from NSCoder)
Encode(NSObject, String) Encode(NSObject, String) Inherited from NSCoder
Encode(Single, String) Encode(Single, String)

Encodes the floating point value using the specified associated key.

(Inherited from NSCoder)
EncodeBlock(IntPtr, nint, String) EncodeBlock(IntPtr, nint, String) Inherited from NSCoder
EncodeConditionalObject(NSObject, String) EncodeConditionalObject(NSObject, String)

When overridden, allows conditional encoding of an object, preserving common references.

(Inherited from NSCoder)
EncodeRoot(NSObject) EncodeRoot(NSObject)

When overridden, allows a graph of objects to be encoded, starting with the specified root obj.

(Inherited from NSCoder)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
Fail(NSError) Fail(NSError) Inherited from NSCoder
FinishEncoding() FinishEncoding()
GetClassName(Class) GetClassName(Class)
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetRequiresSecureCoding() GetRequiresSecureCoding()
GlobalGetClassName(Class) GlobalGetClassName(Class)
GlobalSetClassName(String, Class) GlobalSetClassName(String, Class)
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetClassName(String, Class) SetClassName(String, Class)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetRequiresSecureCoding(Boolean) SetRequiresSecureCoding(Boolean)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TryDecode(String, Boolean) TryDecode(String, Boolean) Inherited from NSCoder
TryDecode(String, Byte[]) TryDecode(String, Byte[]) Inherited from NSCoder
TryDecode(String, Double) TryDecode(String, Double) Inherited from NSCoder
TryDecode(String, Int32) TryDecode(String, Int32) Inherited from NSCoder
TryDecode(String, Int64) TryDecode(String, Int64) Inherited from NSCoder
TryDecode(String, nint) TryDecode(String, nint) Inherited from NSCoder
TryDecode(String, NSObject) TryDecode(String, NSObject) Inherited from NSCoder
TryDecode(String, Single) TryDecode(String, Single) Inherited from NSCoder
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Events

EncodedObject EncodedObject

Event raised by the object.

Finished Finished

Event raised by the object.

Finishing Finishing

Event raised by the object.

ReplacingObject ReplacingObject

Event raised by the object.

Extension Methods

GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
DecodeCGAffineTransform(NSCoder, String) DecodeCGAffineTransform(NSCoder, String)

Decodes and then returns the affine transform structure that is associated with the designated key.

DecodeCGPoint(NSCoder, String) DecodeCGPoint(NSCoder, String)

Decodes and then returns the point structure that is associated with the designated key.

DecodeCGRect(NSCoder, String) DecodeCGRect(NSCoder, String)

Decodes and then returns the rectangle structure that is associated with the designated key.

DecodeCGSize(NSCoder, String) DecodeCGSize(NSCoder, String)

Decodes and then returns the size structure that is associated with the designated key.

DecodeCGVector(NSCoder, String) DecodeCGVector(NSCoder, String)

Decodes and then returns the vector structure that is associated with the designated key.

DecodeDirectionalEdgeInsets(NSCoder, String) DecodeDirectionalEdgeInsets(NSCoder, String)
DecodeUIEdgeInsets(NSCoder, String) DecodeUIEdgeInsets(NSCoder, String)

Decodes and then returns the edge insets that are associated with the designated key.

DecodeUIOffsetForKey(NSCoder, String) DecodeUIOffsetForKey(NSCoder, String)

Decodes and then returns the offset that is associated with the designated key.

Encode(NSCoder, CGAffineTransform, String) Encode(NSCoder, CGAffineTransform, String)

Encodes the affine transform and also associates it with the designated key.

Encode(NSCoder, CGPoint, String) Encode(NSCoder, CGPoint, String)
Encode(NSCoder, CGRect, String) Encode(NSCoder, CGRect, String)
Encode(NSCoder, CGSize, String) Encode(NSCoder, CGSize, String)
Encode(NSCoder, CGVector, String) Encode(NSCoder, CGVector, String)

Encodes the vector and also associates it with the designated key.

Encode(NSCoder, NSDirectionalEdgeInsets, String) Encode(NSCoder, NSDirectionalEdgeInsets, String)
Encode(NSCoder, UIEdgeInsets, String) Encode(NSCoder, UIEdgeInsets, String)

Encodes the edge insets and also associates them with the designated key.

Encode(NSCoder, UIOffset, String) Encode(NSCoder, UIOffset, String)

Encodes the offset and also associates it with the designated key.

GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also