Spread Windows Forms 6.0 Product Documentation
Contains(SmartPrintRule) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SmartPrintRulesCollection Class > Contains Method : Contains(SmartPrintRule) Method


value
Rule (SmartPrintRule object) for which to check

Glossary Item Box

Determines whether the collection contains the specified rule (SmartPrintRule object).

Syntax

Visual Basic (Declaration) 
Public Overloads Function Contains( _
   ByVal value As SmartPrintRule _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As SmartPrintRulesCollection
Dim value As SmartPrintRule
Dim value As Boolean
 
value = instance.Contains(value)
C# 
public bool Contains( 
   SmartPrintRule value
)

Parameters

value
Rule (SmartPrintRule object) for which to check

Return Value

Boolean: true if the object is found in the collection; false otherwise

Example

C#Copy Code
FarPoint.Win.Spread.SmartPrintRulesCollection rules = new FarPoint.Win.Spread.SmartPrintRulesCollection();
FarPoint.Win.Spread.PrintInfo pi = new FarPoint.Win.Spread.PrintInfo();
FarPoint.Win.Spread.SmartPrintRule spr;
object obj = new object();
spr = new FarPoint.Win.Spread.BestFitColumnRule(FarPoint.Win.Spread.ResetOption.None);
rules.Add(new FarPoint.Win.Spread.ScaleRule(FarPoint.Win.Spread.ResetOption.None,1, 2, 0.5f));
rules.Add(spr);
obj = new FarPoint.Win.Spread.LandscapeRule(FarPoint.Win.Spread.ResetOption.None);
if( obj is FarPoint.Win.Spread.SmartPrintRule ) 
rules.Add(obj);
else
throw new ArgumentException("Invalid object type specified: " + obj.GetType().ToString() + " (must be SmartPrintRule).");
pi.SmartPrintRules = rules;
fpSpread1.ActiveSheet.PrintInfo = pi;
bool b;
b = rules.Contains(spr);
if (b == true)
{
MessageBox.Show("The object is in the collection");
}
Visual BasicCopy Code
Dim rules As New FarPoint.Win.Spread.SmartPrintRulesCollection
Dim pi As New FarPoint.Win.Spread.PrintInfo
Dim spr As FarPoint.Win.Spread.SmartPrintRule
Dim obj As New Object
spr = New FarPoint.Win.Spread.BestFitColumnRule(FarPoint.Win.Spread.ResetOption.None)
rules.Add(New FarPoint.Win.Spread.LandscapeRule(FarPoint.Win.Spread.ResetOption.None))
rules.Add(New FarPoint.Win.Spread.ScaleRule(FarPoint.Win.Spread.ResetOption.None, 1, 2, 0.5))
rules.Add(spr)
obj = New FarPoint.Win.Spread.LandscapeRule(FarPoint.Win.Spread.ResetOption.None)
If TypeOf obj Is FarPoint.Win.Spread.SmartPrintRule Then
rules.Add(obj)
Else
Throw New ArgumentException("Invalid object type specified: " + obj.GetType().ToString() + " (must be SmartPrintRule).")
End If
pi.SmartPrintRules = rules
FpSpread1.ActiveSheet.PrintInfo = pi
Dim b As Boolean
b = rules.Contains(spr)
If b = True Then
MessageBox.Show("The rule is in the collection")
End If

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.