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
NSKeyedArchiver
Attributes

Constructors

NSKeyedArchiver()

Default constructor, initializes a new instance of this class.

NSKeyedArchiver(Boolean)
NSKeyedArchiver(IntPtr)

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

NSKeyedArchiver(NSMutableData)
NSKeyedArchiver(NSObjectFlag)

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

Properties

AllowedClasses

The current set of coded classes that allow secure coding.

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

The handle for this class.

DebugDescription

A developer-meaningful description of this object.

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

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

Description

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

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

Handle (pointer) to the unmanaged object representation.

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

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

(Inherited from NSObject)
RootObjectKey

Represents the value associated with the constant NSKeyedArchiveRootObjectKey

Self (Inherited from NSObject)
Superclass (Inherited from NSObject)
SuperHandle

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

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

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

WillEncode

Delegate invoked by the object to get a value.

Zone (Inherited from NSObject)

Methods

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)

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>)

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

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

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

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

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

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

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
ContainsKey(String)

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

(Inherited from NSCoder)
Copy()

Performs a copy of the underlying Objective-C object.

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

Decodes the value at the specified key as a bool.

(Inherited from NSCoder)
DecodeBytes()

Decodes the next item as an array of bytes.

(Inherited from NSCoder)
DecodeBytes(nuint)

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

(Inherited from NSCoder)
DecodeBytes(String)

Decodes the requested key as an array of bytes.

(Inherited from NSCoder)
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)

Decodes the value at the specified key as a double.

(Inherited from NSCoder)
DecodeFloat(String)

Decodes the value at the specified key as a float.

(Inherited from NSCoder)
DecodeInt(String)

Decodes the value at the specified key as an int.

(Inherited from NSCoder)
DecodeLong(String)

Decodes the value at the specified key as a long.

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

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

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

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

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

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSKeyedArchiver object.

DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Encode(Boolean, String)

Encodes the value using the associated key.

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

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

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

Encodes the byte array using the specified associated key.

(Inherited from NSCoder)
Encode(Double, String)

Encodes the double value using the specified associated key.

(Inherited from NSCoder)
Encode(Int32, String)

Encodes the integer value using the specified associated key.

(Inherited from NSCoder)
Encode(Int64, String)

Encodes the long value using the specified associated key.

(Inherited from NSCoder)
Encode(nint, String)

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

(Inherited from NSCoder)
Encode(NSObject)

Encodes the specified object.

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

Encodes the floating point value using the specified associated key.

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

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

(Inherited from NSCoder)
EncodeRoot(NSObject)

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

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

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

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

Invokes synchrously the specified code on the main UI thread.

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

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

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

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

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

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
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[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
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)

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

(Inherited from NSObject)
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)

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

(Inherited from NSObject)
RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

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

Sets the value of the specified key to null.

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

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

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

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

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

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

(Inherited from NSObject)
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)

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

(Inherited from NSObject)
ToString()

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

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

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

(Inherited from NSObject)
ValueForKeyPath(NSString)

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

(Inherited from NSObject)
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)

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

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

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

(Inherited from NSObject)

Events

EncodedObject

Event raised by the object.

Finished

Event raised by the object.

Finishing

Event raised by the object.

ReplacingObject

Event raised by the object.

Extension Methods

DecodeNXColor(NSCoder)
ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
DecodeCGAffineTransform(NSCoder, String)

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

DecodeCGPoint(NSCoder, String)

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

DecodeCGRect(NSCoder, String)

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

DecodeCGSize(NSCoder, String)

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

DecodeCGVector(NSCoder, String)

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

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

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

DecodeUIOffsetForKey(NSCoder, String)

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

Encode(NSCoder, CGAffineTransform, String)

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

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

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

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

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

Encode(NSCoder, UIOffset, String)

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

GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also